- 16 May 2025
-
DarkLight
-
PDF
Using Command Templates
- Updated on 16 May 2025
-
DarkLight
-
PDF
Creating Command Templates
With the Command Template designer, you can execute commands on physical devices to see the actual response and rules evaluation.
-
Navigate to Itential Platform → Studio → Command Templates.
-
Click the plus (+) icon in the top menu to create a new template. The Create dialog opens.
-
Select Command Template from the dropdown menu. Next, enter a template name.
-
Click Create. The Command Template form displays.
-
Enter the device name in the search field (upper right) to select a device.
-
Add the relevant command variables and rules. For more information, see the sections on Command Template Variables and Defining Command Template Rules.
- Click Add Command to add a new command.
- Click Add Rule to add a new rule to a command.
- Click the trashcan icon next to either a rule or command to delete.
-
Click Test This Command for a single command or Test All Commands to test all the commands at once. After evaluating the test output, rules will be marked with either a green check mark (passed)
or red minus sign (failed)
. The device response will appear at the bottom of the screen in the Test results.
Using Command Template Controls
The easiest way to import, export and delete a Command Template is to use the controls from the Command Templates collection page. From the Studio welcome page, click the Search button and the Collection dialog will open.
From this page view, you can Import, Export or Delete command templates by using the controls located in the toolbar at the top of the canvas.
The Export and Delete icons are grayed out (disabled) until the radio button (bottom left circle) of a template card is checked.
Controls Toolbar
A description of each control icon is provided in the reference table that follows.
UI Action | Description | Icon |
---|---|---|
Refresh | Refreshes the Command Templates view in the current window. | ![]() |
Import | Imports a template. | ![]() |
Select All | Selects all templates in the current window. | ![]() |
Delete | Deletes the template when the radio button is selected. | ![]() |
Export | Exports the template when the radio button is selected. | ![]() |
To Export or Delete a template in the list, select the desired template by checking the circle in the lower left corner of the template card, and then click the appropriate icon. Alternately, you can hover over the vertical three dot icon in the lower right corner of a template card to open a menu of options for that specific template, namely Edit, Clone (create a copy), Delete or Export.
You can open any template by clicking the name (in blue) at the top of the card. When a template is open, a new template can be Imported using the icon located in the top toolbar on the left. Additional options to View metadata, Clone, Revert changes, Export or Delete the open template can be found by clicking the three dot menu icon found in the top right corner.
Importing a Command Template
Clicking the Import ![import] icon opens the Import dialog. Select Command Template from the dropdown list and then use the search bar to locate the desired template file for import. Once the file is selected for upload, click Import.
Exporting a Command Template
Clicking the Export icon will open a dialog box with the options to open the template file or save it to a specific location.
Deleting a Command Template
After clicking the Delete icon, a confirmation box pops up and prompts the user to confirm the delete action. Once a template is deleted, it cannot be undone. It will no longer show in the Command Templates collection view.
Click OK to confirm the deletion.