Configuration Change Templates in icom Router Management permit to roll out customised configurations for each router.

The icom Router Management for all router models based on icom OS permits roll-outs of device firmware, configurations, security certificates and applications.

Situation

You have a number of routers in the field to which you want to roll out a router-specific configuration together in one operation in the icom Router Management.

You may want to update the configuration of all routers with individual location data for each router, for example.

The use case is exemplary and can be used for any configuration options.

Solution

Add custom fields for individual variables in the icom Router Management. Fill these fields for each router with its individual data. Create a config change template that generates an individual configuration file for each router, retrieving the individual values from its custom fields. Apply the config change template to the router(s).

Adding custom fields

Add custom fields that you can fill with individual data for each router. In this example, these are fields for the town, the street and the house number, which will then be used to compose the location.

  1. Log in to the icom Router Management.

  2. Click on cog Settings → file edit Custom fields in the title bar and select plus Add
    cg en rm config templates 01

  3. Enter the Name of the custom field, e.g. town.

  4. Enter an optional Description of the new custom field, e.g. Town.

  5. Sepcify the Data Type of the new custom field, in this case string.
    string: the data content of the custom field is a string (text)
    boolean: the data content of the custom field is 0 or 1
    number: the data content of the custom field is a number

  6. Click on   Add  .
    cg en rm config templates 02

  7. Add two more custom fields for the street and house number as follows.
    cg en rm config templates 03

You have added the custom fields for the description of the location with this.

Entering the location data of the router(s) into the custom fields

Enter the detailed data of the location for each router.

  1. Check on the package variant closed Inventory → Routers page the router you want to edit and click under flash outline Actions on pencil Edit .
    cg en rm config templates 04

  2. Change to the Custom Fields tab and enter the desired location data in the respective custom field.
    cg en rm config templates 05

You have entered the location data for this router with this. Proceed in the same way for further routers.

Creating the config change template

Create a config change template that composes the exact location of each router from the data entered for it and then writes it to the router.

  1. Select on the package variant closed Inventory → ASCII Templates page plus Add.
    cg en rm config templates 06

  2. Enter the Name the config change template, e.g. location_update.

  3. Click on   plus  ADD NEW PARAMETER  , enter a Name for the parameter, e. g. Town, and select for the new parameter the custom field Town from the Type drop-down list.
    cg en rm config templates 07

  4. Click on plus above Actions and enter two further parameters for street and number as follows. [1]
    cg en rm config templates 08

  5. Under Template, enter the CLI command for setting the location administration.hostnames.location=.
    cg en rm config templates 09

  6. Locate the cursor directly behind the entered command and click behind the parameter for the town on application braces plus outline Copy parameter into template to insert the variable for the town.
    cg en rm config templates 10

  7. Locate the cursor directly behind the entered parameter, enter a comma and a blank, and click behind the parameter for the street on application braces plus outline Copy parameter into template to insert the variable for the street.
    cg en rm config templates 11

  8. Locate the cursor directly behind the entered parameter, enter a blank, and click behind the parameter for the number on application braces plus outline Copy parameter into template to insert the variable for the number.
    cg en rm config templates 12

  9. Under Template enter in the line below the CLI command for setting the location the CLI command for activating the profile administration.profiles.activate.
    cg en rm config templates 13

  10. Click on   Add  .
    cg en rm config templates 14

You have crated the following config change template with this:

administration.hostnames.location={{ .Town }}, {{ .Street }} {{ .Number }}
administration.profiles.activate

A click on flash outline Actions → play Dry run upon checking the configuration template permits to test this.
cg en rm config templates 15

Note A dry run requires that valid data must be entered for the respective custom fields in the router, which are used in the configuration template.

To do this, select the router and click on   Dry run  .
cg en rm config templates 16

The configuration file generated from the config change template for this router is displayed.
cg en rm config templates 17

  1. Click on   Close   to exit the dry run.

Applying the config change template to the router(s)

Apply the config change template to the router(s) for which you have defined the location information.

  1. Check on the package variant closed Inventory → ASCII Templates page the above created configuration template and click on flash outline Actions → autorenew Apply to router.
    cg en rm config templates 18

  2. Select the router(s) to which you want to apply the config change template and click on   Continue  .
    cg en rm config templates 19

  3. Review the selection of ASCII template (preselected) and router(s) and click on   Continue  .
    cg en rm config templates 20

  4. Enter optionally a unique name for the update operation, select the time for the update (here Immediately) and click on   Finish update  .
    cg en rm config templates 21

  5. Click on   To Update Job view   upon successful creation of the update operation.
    cg en rm config templates 22

Result testing

Verify the successful execution of the config change template for the update operation and verify the configuration change on the router.

  1. Verify in the Update Job view (update Updates → Update Jobs menu) whether the update operation has been executed successfully.
    cg en rm config templates 23

  2. Open the web interface of the router: https://192.168.1.1/ui/index.html [2]

  3. Verify on the view dashboard outline Status → Dashboard page whether the Location in the Device info field has been updated.
    cg en rm config templates 24

Note The Location information in the router overview (package variant closed Inventory → Routers menu) can be specified optionally when adding the router in the icom Router Management and does not indicate the location configured in the router that has been updated with this config change template. Therefore, this information is not changed by the application of the config change template.

Tips and Tricks

  • The available CLI commands and their syntax can be determined using the command line interface (CLI). Refer to the Online Help of the router for details.

  • Config change templates also permit to use variables that are prompted when applying the config change template. In this example, it would be possible to add another optional attribute for defining the location to the router.
    cg en rm config templates 25
    cg en rm config templates 26

Troubleshooting

  • In case a page in the icom Router Management shows an unexpected behaviour, an update of the page in the browser using refresh Ctrl+F5 helps in many cases.

Back to the Configuration Guides for icom Router Management

Back to overview

1. Special characters are not allowed in the parameter name.
2. Login depending on configuration; default for earlier firmware versions: User name: insys, Password: icom