Template Builder allows you to parse command responses in your workflows using pre-built or custom templates. The application takes text input in the Console area and parses it in real-time against a template in the Template area. Template Builder returns the parsed results in the Response area as a data table. By parsing complex data that is normally verified by manual interaction, you have real-time information to make better decisions about your system.
Note: The Itential Automation Platform (IAP) is compatible with several third-party software products for network operating environments. Beginning with the system requirements for 2019.1.2, all third-party software version compatibility is documented in Release Notes. To get the most up-to-date requirements for any third-party software, including open source, first identify which IAP release you’re using and then refer to the respective release note.
The Console and Template areas are parsed in real-time against your templates to give instant feedback about what is working and what is not.
Template Builder has over 200 ready-to-use templates based on the most common device commands. Use these templates to parse command responses in your workflows.
This section provides a quick walk-through of the Template Builder interface.
The left navigation menu allows you to scroll through a list of default templates and custom templates you create. Each template is divided into a custom group, usually based on the device type. You can click on any template to view it in the main canvas (right of left menu).
Type a template name, group or command in this field to filter template results.
Templates are grouped together for easy organization and navigation.
Template Menu Actions
Template actions will display when you hover over a template list item.
|Export||Use this action to export a template to be used by another user of IAP (Itential Automation Pronghorn).|
|Duplicate||Create new templates by duplicating a current template. You can use a duplicate template as a starting place to create a custom template.|
|Delete||Delete templates you no longer want. Only user-created templates can be deleted.|
|Name||Enter the name of your template. System templates use a combination of the template group and the command field for their name.|
|Template Group||Used to group your templates into collections. This allows you to easily find the most relevant templates you may later need later.|
|Command||Allows you to specify the command the template should run against.|
|Create||Create a new blank template. To save a new template, you must add a name, template group and command.|
|Import||Import a template to add to your template list. The imported template will display in the template editing area.|
|Save||Save progress on a current template.|
The Console area serves as a way to test your template against a typical text response you would expect. This text will be parsed by your template and the output will be displayed in the Response area below. Any text can be parsed by TextFSM. The most common use case is to parse CLI response text since it usually does not provide a system level response that can be parsed.
The Template area contains the TextFSM template that will parse your console text. Use the prebuilt templates to modify the TextFSM template; you can also use it as a guide to write your own custom template. As you make modifications to the template, the Response area will update with the data object from TextFSM.
Output from the template engine TextFSM is displayed in the Response area in the form of a data table. This response can be used in workflows in the form of an object.
Creating Custom Templates
TextFSM can be difficult to understand at first but if you use existing templates as your guide, you can become more familiar with how they work. With the real-time TextFSM engine, you can see how your response updates when the Template or Console text is modified. You can copy/paste the example templates into Template Builder and modify the value/state definitions to create a custom file.
Note: For more detailed information on TextFSM, refer to following wiki on GitHub: Google TextFSM Wiki.
|Modifying an Existing Template||You can modify any existing template through the Console and Template areas. Changes made to an existing template are not saved until you click Save Template.|
|Import / Export a Template||Use the Import and Export buttons to move templates in/out of the system. You can also use the Import and Export buttons to share any custom templates you have created with other IAP users.|
|Create a New Template||Create a new template by clicking the Create button at the top right corner of the page.|
|Delete a Template||Delete a template you no longer need to reduce clutter in your navigation area. Hover over the template in the left Menu Navigation and click the Delete button to the right of the template name.|