Device Templates are the easiest and fastest method for configuring multiple AirLink routers. AirLink OS gives you several options for creating, modifying and applying templates.
When working with templates, please consider that a template must be applied to routers of the same model type and OS version as the router from which the template was created.
Before working with templates in ALMS, ensure that you synchronize the router. The synchronization updates all the information from the router, and ensures that router configuration data is up to date in ALMS.
Initializing Table Of Contents...
To start working with templates from AirLink OS, click the Templates icon and select an option:
The AirLink OS screen banner changes color and states TEMPLATE mode is ON. In Template mode, check boxes appear next to text boxes, table rows, and tables so you can select items to add to the template.
To cancel template mode, click the Cancel icon or CANCEL on the Template status bar (see below).
Create template from scratch
You may want to use this option when deploying minor configuration changes across multiple routers.
To create a template:
Click Create template from scratch.
You can now begin adding settings to your template.
To add a setting, select the checkbox next to the setting. The setting and its current value will be added to the template.
You can also select a checkbox in a table to add the contents of a table row to the template, or click to delete/reset a table row (or an entire table) in the template.
To save the template, click EXPORT (in ALMS) or EXPORT TO FILE (when using a locally connected computer).
If you are using ALMS, you can click EXPORT TO FILE to save the template to your computer, or click EXPORT TO MY ALMS ACCOUNT to save the template to ALMS.
When using a locally connected computer logged in to the AirLink OS UI, the option shown is EXPORT TO FILE, which saves the JSON file to the local computer. There is no option to export to ALMS.
Tips
For security reasons, sensitive information such as passwords and passphrases cannot be extracted from a router. Therefore, passwords and passphrases are not automatically included in a new template. If you select any configurations that include a password, you must re-enter the password before you can add it to the template. See Adding Passwords to a Template.
The Template status bar shows you how many settings have been added to the current template.
You can click the arrow > to display the settings you have added. Click UNSELECT to remove settings from the template.
When you add a setting, it will automatically also add any dependencies.
If you change your mind and remove the setting from the template, it will not automatically remove all the dependencies. For example, if you select a Wi-Fi Access Point and add it to a template, it will include the Default LAN segment settings associated with that access point. These settings will overwrite the Default LAN configuration on the target device.
Create template from current configuration
You may want to use this method when you have a configured device and want to deploy additional devices “out of the box” based on the configured device.
This option creates a template using all settings that were modified by a user (different from their factory default) except for sensitive information such as passwords and passphrases and SIM Template settings. See Using the SIM Database and SIM Templates for information on how to include SIM Templates in a device configuration template.
To create a template using your current device settings:
Click Create template from current configuration.
Template mode is ON. The status bar shows the number of fields added to the template. Click > to view all the fields to be added.
Add or de-select settings as you require.
To save the template, click EXPORT (in ALMS) or EXPORT TO FILE (when using a locally connected computer), as described in Create template from scratch.
Tips
For security reasons, sensitive information such as passwords and security passphrases are not automatically saved to a new template. If you select any configurations that include a password, you must re-enter the password before you can add it to the template. See Adding Passwords to a Template.
Click UNSELECT to remove fields from the template. The system will not automatically remove any dependent fields. For example, if you select a Wi-Fi Access Point and add it to a template, it will include the Default LAN segment settings associated with that access point. These settings will overwrite the Default LAN configuration on the target device.
Click settings with an arrow > to view the list of all template settings under that heading. Grayed-out items are settings that are currently hidden from the user.
Modify a template
Open an existing template in order to modify it by adding, removing, or updating settings and then save the template for future use.
To modify a template:
Click Modify a template from local file.
Browse to your file and then click Open.
The template loads into your browser, and Template mode is ON.
A template created from a different firmware version or device type other than the one currently in use cannot be uploaded for modification. A notification alert will indicate incompatibility and you will not be able to proceed further.
Edit and select settings and tables as described above.
To save the modified template, click EXPORT TO JSON, and then save the file.
Apply a template
Use this option to import a .json template file and apply it to your device.
Templates created from different software versions or different hardware cannot be applied to the router. “Version mismatch” and “Product mismatch” alerts will indicate incompatibility.
Semtech recommends that, when using a template to apply an entire device configuration to a fleet of routers, the target routers should be at factory default settings.
A template intended to configure only a few settings (created using Create template from scratch, for example), can be applied to routers that are already configured and operational.
To apply a template:
Click Apply a template.
Browse to your template file, and then click Open.
A confirmation message appears.
On the status bar, click > to view which settings the template will update.
To apply the new settings from the template, click SAVE.
If you need to modify a full-device configuration template after applying it to your target routers, ensure that the target routers are returned to factory default settings before applying the template again.
Adding Passwords to a Template
For security reasons, sensitive information such as passwords and passphrases cannot be extracted from the router and copied into a new template. If you select any configurations that include a password, you must enter the password before you can add it to the template. Note that this procedure only adds a password to the template. Any passwords on the router from which you are creating the template cannot be changed in template mode.
Please be aware of this requirement whenever your template includes configurations for:
Wi-Fi
Cellular Virtual APN
Captive Portal
IPsec VPN or OpenVPN
Generated Certificates and EST Credentials
SMS
User Accounts with LDAP, RADIUS or TACACS+ servers
Some password fields are readily visible in template mode, such as the SMS password shown below.
To add the password to the template, click the password field and enter the password.
Tip: As you enter the password, click Show/Hide to reveal the entry in plain text.
After entering the password, select the checkbox, and the password is included in the template.
Other passwords can be found within a configuration menu that will appear after clicking (edit) in a table, for example.
In this case, you can enter the password or passphrase and then click DONE.
Initializing Table Of Contents...
and select an option:
or CANCEL on the Template status bar (see below).
to delete/reset a table row (or an entire table) in the template.
to delete/reset a table row (or an entire table) in the template.
(edit) in a table, for example.
