Create Runbook Containing Configlet Node from Runbook Template
The Configlet node can be pre-configured in a Runbook Template to simplify Runbook creation for end users. This section explains different methods to create and use Runbook Templates that contain Configlet nodes and how to enhance them:
- Create Runbook Containing Configlet Node from Runbook Template
- Add More Golden Config using Search Phrase (Set the Search Phrase Value with Input Dialog)
- Add More Golden Config using Search Phrase (Set Constant Value as Search Phrase)
Create a Runbook Template using existing Golden Config and Config Parser
You can create a Runbook Template that includes pre-defined golden config rules and config parser variables:
-
Save a runbook containing a well-defined Configlet node as a Template:
- Open the runbook with pre-defined Configlet node.
-
Click the
icon, then select Save as Template. The template will open in Template Editor mode.
- Click Save and in the Save Runbook Template dialog, specify the name and the folder location.
-
Click OK to save the Runbook Template.
-
To create a new Runbook using the template created in previous step:
- Open the Runbook template manager and switch to All Runbook Template
- Select the template save in Step 1.
-
Click Create Runbook.
A new Runbook is created with the same name and you can further modify the Runbook if needed. The Configlet Node will automatically include:
- Devices from the current map
- The golden config rules and config parser variables defined in the template
Add More Golden Config using Search Phrase (Set the Search Phrase Value with Input Dialog)
You can dynamically add more golden config rules to the Configlet node using the search phrase passed through a Runbook Template variable. You can select global RBT variables to use as search phrases.
For example: Use the search phrase BGP to add more golden config to the Configlet Node:
-
Open the runbook containing a Configlet node >> click the
icon, and select Save as Template.
-
In Edit mode, click the Start node and add a new Runbook-level template variable:
- Click +Add to open the Define Variable dialog.
-
Name the variable (e.g.,
search_phrase) and set its type (default is string). - Set the Value to <Input Dialog>.
-
Provide a description and click OK.
-
Click the Configlet node to define node level template variable:
- Select Items to Templatize: From the dropdown menu, select and add the item Search Phrase.
-
Assign the
search_phrasevariable created in step 2.
- Click Save, enter a name (e.g., "ACL Config Template") and select the folder for template location.
-
Click OK to save and close the window.
-
Now create a new Runbook using the template created in previous steps:
-
From side menu bar, open the Runbook template manager and switch to All Runbook Template.
- Select Map: Set it to <Current Map> to consider the devices on map as target devices.
- Select the template created in earlier steps.
-
Click Create Runbook.
-
The runbook will open in editor mode with a pop-up dialog. Enter the value (e.g., “BGP”) for
search_phrase -
Click OK to close the window and create a new runbook.
A new Runbook is created. The Configlet node will automatically include golden config rules matching the search phrase BGP. You can edit the Runbook if needed.
-
From side menu bar, open the Runbook template manager and switch to All Runbook Template.
Add More Golden Config using Search Phrase (Set Constant Value as Search Phrase)
Alternatively, set a fixed (constant) search phrase during template creation. No input is needed when creating a Runbook.
For example: Use the search phrase "BGP" to add golden config to the Configlet Node.
-
Open the runbook containing a Configlet node and click
Menu > Save as Template.
-
In the Edit mode, configure the search phrase variable in Start node:
- Click the Start node and add a new runbook-level template variable:
-
Click +Add, then name the variable (e.g.,
search_phrase) and set Type to string. - Set Value: Enter the text BGP.
-
Add a description and click OK.
-
Assign the template variable created in earlier step to the templatize item Search Phrase:
- Click the Configlet Node.
- Go to Select Items to Templatize: From the dropdown menu, select and add the item Search Phrase.
-
Assign the
search_phrasevariable to this item defined in step 2.
-
Save the template (e.g., "BGP Config Template") and click OK.
-
Now create a new Runbook using the template created in previous steps:
-
From side menu bar, open the Runbook template manager and switch to All Runbook Template.
- Select Map: Set it to <Current Map> to consider the devices on map as target devices.
- Select the template created in earlier steps.
-
Click Create Runbook.
-
From side menu bar, open the Runbook template manager and switch to All Runbook Template.
-
Click Build to execute the automation and view the results.
A new Runbook is created with the same name as the Runbook Template. The Configlet Node will automatically include golden config rules matching the search phrase BGP. You can edit the Runbook if needed.