Documentation forNetwork Configuration Manager

About NCM config change templates

Config change templates can be used to change the configurations on multiple devices across the network. Examples of routine changes you can expedite with config change templates include:

  • Changing VLAN membership by device port
  • Configuring device interfaces based on description
  • Enabling IPSLA for VOIP implementations
  • Managing NetFlow collection at the source devices

Config change templates are powerful, configurable scripts that allow for:

  • Conditional logic (if/then/else statements)
  • Control flow (for each interface, do this)
  • String and value comparison
  • Data access from the Orion Platform database

If the config changes you need to make do not require advanced logic, you can use scripts to change configurations on multiple devices. Scripts can be executed manually or scheduled.

Before devices can be targeted with a config change template, the devices must have been inventoried in NCM. Running an inventory makes device data available to NCM through the SolarWinds Information Service (SWIS) API.

Creating and using config change templates

NCM ships a variety of config change templates, which you can execute to make common config changes. You can also create custom config change templates.

Two types of NCM users work with config change templates:

  1. The template creator defines the config change template. The config change template definition includes:
    • Variables that describe the template's purpose and prompt the template user for values when the config change template is executed. For example, if the config change template changes a password, the definition would include a variable to prompt the user for the new password.

    • A script that generates a series of CLI commands. When the config change template is executed, these CLI commands run on each targeted device.

    The template creator must know the basics of writing a script that uses commands, variables, and logical structures. Creating or editing a config change template requires the NCM role of Administrator or Engineer.

  2. The template user executes the config change template. At execution, a run-time wizard prompts the user to:
    • Select the devices that the config change template targets.
    • Provide values for the variables defined in the template.

    Based on this input, the config change template creates a series of CLI commands and runs them on each targeted device.

    Executing a config change template requires the NCM role of Administrator, Engineer, or WebUploader.

Learn more

For more information about creating new config change templates or modifying existing templates, see:

To run a config change template, see Execute an NCM config change template.