- 23 May 2023
-
DarkLight
-
PDF
Template Designer
- Updated on 23 May 2023
-
DarkLight
-
PDF
The Template Designer in Configuration Manager allows you to define a Jinja2 supported configuration set that can be applied to a batch of devices. These templates support full CRUD functionality with the Jinja2 Template Engine integration that supports variable declarations for dynamic config operations.
Creating a Template
From the Configuration Manager sidebar, click the create (+) button near the top.
Figure 1: Create Button
Once the Create dialog appears, click the dropdown box and select Configuration Templates from the menu. You will then be asked to provide a name for the template.
Figure 2: Create Dialog
Once the template is named, click the Create button to finalize the creation of the template.
Figure 3: Create Template
Modifying a Template
Once the new template is created, you will be redirected to the Template Designer screen. On this screen you will see the primary text editor; this editor is where you will define your device templates.
Figure 4: Template Editor
Once you've defined your desired configuration block, click the "Floppy Disk" icon at the very top to save. If you would like to revert your configuration to your previously saved state, click the circular back arrow button.
You may also define your variables by clicking the variables button (x) at the top right corner of the configuration editor. A variables editor will open.
Figure 5: Variables Editor
In the variables editor you can define your variables in a valid JSON format. Once all variables are defined, save them by clicking the "Floppy Disk" icon at the top right side of the variables editor. These variables will be used by Jinja2 to render the template when you choose to apply the configuration to one or more devices.
Figure 6: Save Variables
If you would like to modify the template name or template read-write permissions, you can do so by clicking the stacked 3-dots button at the top right of your screen and selecting View Metadata.
Figure 7: View Metadata Button
From this screen you can rename your device template or change template permissions. You can retain your desired changes by clicking the Save button.
Figure 8: Save Metadata
Applying a Template
After creating a desired configuration you can apply it to one or more devices. In order to select the devices you would like to apply the configuration to, hover over the Select Device button.
Figure 9: Select Devices Button
Hovering over the Select Device button will open a dialog with a device list. You can navigate through the list using the pagination controls or search for a specific device by name. Once you've found the devices you would like to apply the configuration to, select them by clicking the check boxes.
Figure 10: Select Devices
Once you've made your device selections, click the Apply to Devices button. Clicking this button will open an execution log that will show you the current status of your configuration application request. This execution log will also tell you when the process has been completed.
Figure 11: Execution Log
Deleting a Template
If you would like to delete a template, click the stacked 3-dots icon on the top right and select Delete Device Template.
Figure 12: Delete Device Template Button
After clicking the delete button you'll be asked verify that you would like to delete the template.
Figure 13: Confirm Deletion
Clicking Delete from this dialog will permanently delete your configuration template.