Configlets in Network Configuration Manager (NCM)

A configlet is a configuration template that is transformed to a CLI configuration string and applied to devices. You can use variables to define dynamic elements, allowing them to act as input variables and take values based on the execution context.

Use Case

Often, there is a need to make changes to the running configuration of devices, and in most cases, the same set of changes needs to be applied to multiple devices. While network administrators can manually edit the configuration, the task can be challenging due to the volume of changes and the repetitive nature of the work. Site24x7's Network Configuration Manager (NCM) provides a simple solution through configlets.

You can create a configlet according to the changes that needs to be applied with the required input variables. When the configlet needs to be executed, you can provide the values and select the required devices where it should be executed. 

Adding a configlet

1. Log in to your Site24x7 account.
2. Navigate to Network > NCM > Configlets. 
3. Click Add Configlet on the top right of the screen. 
4. Enter the values for the following fields:
   
   1. Display Name: Provide a unique name to identify the configlet.
   2. Description: Provide an appropriate description for the configlet. 
   3. Execution Mode: Select an Execution Mode from the drop down menu:
      
      1. File Transfer Mode: To upload a fragment configuration change through TFTP.
      2. Script Execution Mode: To execute a single command on the CLI console.
      3. Advanced Script Execution Mode: To execute a sequence of commands on the CLI console based on prompt action and by adding conditions (if needed).
   4. Vendor: Select a device vendor to ensure that the configlet can be executed on devices provided by this vendor. 
5. Command: The form changes based on the Execution Mode selected in step 4. 
   
   1. If you have selected File Transfer Mode or Script Execution Mode: Only the Command field is displayed. You can add multiple commands by clicking the plus + icon beside the field. 
   2. Advanced Script Execution Mode: Add Command according to the Sequence in which it must be executed. Provide values for Prompt, Timeout, Suffix, Delay, and click the pencil icon beside Conditional Action to add Condition, Value (which is a regular expression corresponding to the desired pattern), and the step to be executed on Success or Failure, which can be a step number or end of execution. For more information, refer to the section More on Advanced Script Execution Mode. 

Viewing configlets

1. Navigate to Network > NCM > Configlets. 
2. View details like Name, Execution Mode, Vendor, and Description.
3. In the Action column, select:
   
   • Pencil icon to edit a configlet.  
   • Trash icon to delete a configlet. 
   • Play icon to execute a configlet. 

Editing a configlet

1. Navigate to Network > NCM > Configlets. 
2. Click the pencil  icon beside the configlet that you wish to edit.
3. Make the necessary changes, then click Save. 

Deleting a configlet

1. Navigate to Network > NCM > Configlets. 
2. Click the delete  icon beside the configlet that you wish to delete.
3. In the Delete Configlet pop-up, click Delete. 

Executing a configlet

1. Navigate to Network > NCM > Configlets. 
2. Click the play  icon beside the configlet that you wish to execute.
3. In the Execute Configlet screen, provide input values for Configlet Variable(s) (if any). Then select the Device(s) on which the configlet must be executed.
   
   
   Figure 1. Executing a configlet.

Execution History

1. Navigate to Network > NCM > Configlets > Execution History. 
2. View details like Configlet Name, the Device Name where it was executed, Invoked Time, Invoked By, Execution Time, and Status. 
   

More on Advanced Script Execution Mode

The Advanced Script Execution Mode allows users to execute a series of commands on a device through the command line. To do this, you must provide the commands that need to be executed in a specific format, as shown in the examples below. 

Related Articles

• NCM Configuration Summary
• Network Configuration Manager best practices guide