GDMS Configuration Template Management Guide

  • Updated on December 14, 2023

The Device Configuration page allows users to create templates that can be used to provision devices of the same model or in the same group.

By Model/Group Functions:

 By Model

By Group

Overview

1. The user can set multiple templates for a single model by different sites.

2. For all sites in the GDMS account, each model only has template.

The user can separate the same series devices (different models) to the same group and create one template for the group.

Push Configuration Mechanism

Model Y

  • Auto Push: When the device is added into GDMS platform, the model template will be provisioned into the device automatically.

  • Manual Push: Select to provision the devices manually.

  • No Auto Push Function

  • Manual Push: Select to provision all devices in all sites or select the specific devices for provisioning. The user can also push the template to the device which is not in the current group.

Configured Parameters

All configuration parameters in this model (including special parameters in this model)

Template Number Limitation

No Limitation

No Limitation

Scenario

The user wants to configure the device with the latest configuration parameters. Once the device is online, it will obtain the latest configuration parameters.

The user only wants to provision the general configuration parameters to the same series devices. Users can create multiple group templates for one series.

BY MODEL

Users could customize the configuration template and classify the templates by device model and site. Users could also configure a batch of devices on the GDMS platform, which means users could create a configuration template for all same model of devices or create multiple templates for different sites.

Automatic Configuration Push

When a device is added to GDMS for the first time, it will automatically obtain and use the configuration template for its model.

Manual Configuration Push

To manually push the configuration to specific device models, click on the button of the desired models.

Manual Configuration Push

If a device’s setting has not been modified in the Device Management 🡪 Device 🡪 Set Parameters page, GDMS will automatically update the device with the template settings created in the Device Configuration page.

Example:

For GXV3370 devices, all sites are using the same configuration template, and all the devices under the site A – D will acquire the same configuration template – GXV3370 Config Template.xml.

For DP720 devices, different sites have different configuration template. The DP720 in site A will acquire the DP720 configuration file – Config Template -1.xml; the DP720 in site B will acquire the DP720 configuration file – Config Template -2.xml.

Example – GXV3370

Add Template

To add a configuration template for a specific device model, click on the Add Template button in the By Model page and enter the following information:

Add Template

Name

Enter the name of the template.

This name must be unique and has a maximum character limit of 64.

Model

Select the device model of the template.

Select Site

Select the site which the template will be used for.

All Sites: All devices in all sites will use this template.

Select Site: All devices in the selected sites will use this template. Multiple sites can be selected.

None: GDMS platform will not allocate the template to any device. The user could allocate the template to the device manually.

Description

Users could input the descriptions of the template and the purpose.

Table 1: Add Template

Once complete, users will be redirected to the Set Parameters page to modify the device settings of the template.

  • For the new associated device, when the device first time connects to the GDMS platform, it will acquire the configuration template according to the device model and site automatically. Users do not need to push the configuration template manually.
  • Devices already on GDMS will not automatically obtain the settings from newly added configuration templates. Users will need to update these devices manually.

If the GDMS platform has the model configuration template for the current device, and the user does not modify the configuration parameters from the Device Management 🡪 Device 🡪 Set Parameters menu, the GDMS platform will push the default model configuration template to the device when the device is online. Otherwise, if the user updates the device configuration on “Set Parameters” menu on the GDMS platform and push to the device, the device will use this configuration as the default configuration.

Set Parameters

Users can configure model-specific settings when editing model templates.

  1. To configure these model-specific settings, click on the of the desired template.
Set Parameters

      1. Clicking on the Select All button will select every option on the current page. Clicking on it again will deselect all the options.
      2. Clicking on the Reset Settings button will restore all settings on the current page to default values.
  1. Modify the desired settings on the page or click on the Switch To Text Editor to configure device settings via text editing (i.e. p-values). Key can be either a P-value or an alias.

  • The available settings for each model template are different. For more details on acceptable configuration values, please refer to the user guide for each device model.
  • When the user adds a new model configuration template in GDMS platform, the GDMS platform will not push the template to the existing devices in the GDMS platform, and the GDMS platform will only push the new added template automatically to the new associated devices in the system.
  • When the settings of a template are modified, the changes will not be automatically applied to related devices. Users will need to manually push the configuration to devices.
  • For the new added devices, the devices will acquire the updated configuration template automatically.
  • If a scheduled task involves a modified template, the task will use the template settings at the time of scheduling, not the newly modified settings.

Push Update

Users could push the configuration template to the device manually.

Select a specific configuration template, click on the button following the template.

Push Configuration File
  1. Users could select any device in this device model to push the configuration template, the device will be updated with the configuration template.
  2. Users can either push the configuration template immediately or schedule the configuration push for a specified time. If the latter is selected, users will need to enter a name and time for the scheduled push.
Schedule Config Update
  1. Click on the Save button to finalize the task. Users can check the task status in the Task Management page.

Edit Template

To edit the configuration template’s name, site, and description, click on the button for the desired template.

Edit Model Template

Download Configuration Template

To download the configuration template of a device model, click on the button for the desired template.

Figure 8: Download Configuration Template

Delete Template

To delete configuration templates from GDMS, select the desired templates and click on the Delete button in the top left corner of the By Model page.

If a scheduled task involves a deleted template, the task will still use a temporary copy of the template saved at the time of scheduling. A scheduled task will not fail due to deleted templates.

Delete Template

BY SITE

GDMS offers the customization of device templates based on the sites in which they are deployed. The user can create site template and assign it to one of the site previously created. Once the template is assigned to a specific site, all the devices which belong to that site will receive the configuration set on the template.

The user can assign the template to one or more sites to have the configuration apply to multiple devices across many sites.

Add Site Template

To create a template for site please unfold the “Template” tab in the GDMS web UI and click on “By Site”.
On the top right corner of the graphical interface, click on “Add Site Template”.

Templates – By Site
Add Site Template

Name

Enter the name of the template.

Auto Provision to Devices in

Select at least one site to which the template will be applied.

Description

Enter a description for the template.

Set Parameters

The user can set the unique parameters of the devices in the site in the configuration template in order to push the unique parameters to the devices in the sites.

To access the parameters of the template, on the main page of the templates, then click on

Set Template Parameters

The settings can either be edited using the respective fields in the GUI, otherwise, the user can click on

BY GROUP

Users could customize the configuration template by group. Users could configure a group and update the configuration template by group. For example, users could classify a batch of devices to a group and configure/manage the devices in the group. Users could push the configuration template to the group members on the GDMS platform.

Users could view the group configuration template, and the devices list in each group.

Users could modify the configuration parameters, push the configuration to the devices, edit the group and members, and download the configuration template by group.

By Group

Add Group

Users could add a group at any time on the GDMS platform.

  1. Click on the Add Group button at the top right of the By Group page.
Add Group

Group Name

Enter the name of the group to easily identify it. Names must be unique and have a maximum character limit of 64.

Type

Users need select the type between DP series and Non-DP series:

  • DP series: Use the configuration template for DP series.
  • Non-DP series: Use the configuration template for GXV series, GRP series, GXP series, and WP series, and the configuration template includes all parameters in these products.

Description

Enter the detailed description and purpose of the configuration template.

Table 2: Add Group

  1. Once complete, users will be redirected to the device selection page to add devices to the group. Users can either select devices from the list or manually enter the MAC addresses of the devices. Selected devices will be moved to the Selected Device list on the right of the page.
Finish Adding Group
  1. Users could click on “Prev” button to go back to the group configuration page to re-edit the group information.
  2. Click on the Save button to complete group member selection. Users will then be redirected to Set Parameters page.

Users need to set the parameters of the configuration template for the newly added group.

Set Parameters

Users could set the unique parameters of the devices in the group in the configuration template in order to push the unique parameters to the devices in the group.

  1. Select a specific group, click on the button to access the group member parameters configuration page.
  2. Modify the desired settings on the page or click on the Edit Configuration File to configure device settings via text editing (i.e. p-values). Key can be either a P-value or an alias.

  • The available settings for each model template are different. For more details on acceptable configuration values, please refer to the user guide for each device model.
  • When the user adds a new model configuration template in GDMS platform, the GDMS platform will not push the template to the existing devices in the GDMS platform, and the GDMS platform will only push the new added template automatically to the new associated devices in the system.
  • When the settings of a template are modified, the changes will not be automatically applied to related devices. Users will need to manually push the configuration to devices.
  • For the new added devices, the devices will acquire the updated configuration template automatically.
  • If a scheduled task involves a modified template, the task will use the template settings at the time of scheduling, not the newly modified settings.

Push Update

Users could push the group configuration template to the device manually.

  1. Click on the button for the desired group.
Figure 13: Push Update
  1. In addition to being able to push the configuration template to all or select members of the group, users can also push it to non-members.
  2. Users can either push the configuration template immediately or schedule the configuration push for a specified time. If the latter is selected, users will need to enter a name and time for the scheduled push.
  3. Click on the Save button to finalize the task. Users can check the task status in the Task Management page.

Edit Group

Users could edit the group name, descriptions, and group members.

  1. Click on the button for the desired group.
Edit Group
  1. Modify the desired settings and click on the Save button to finalize changes.

New members of an existing group will not automatically obtain the group configuration template. The template must be manually pushed to the new member devices.

Download Configuration File

Users can download the group configuration template by clicking on the button for the desired group.

Download Configuration File

Delete Group

Users can delete groups by selecting the desired groups and clicking on the Delete button in the top-left corner of the By Group page.

The existing timing tasks involved the group configuration template will be reserved, and the timing task will be executed with the original group configuration template.

BY CFG

Users can import configuration files for specific devices. Settings in these uploaded files will be used for their specified device.

By CFG

Upload CFG File

Users could upload the custom configuration file to the GDMS platform and push the custom configuration file to the device.

  1. Click on the Import Configuration File button at the top-right corner of the By CFG page. The following window will appear:
Upload CFG File
  1. Drag and drop the file to the window or click on the upload icon to select a file from your PC.

The uploaded file must be named as the device’s MAC address (e.g. 000b82afd0b0.xml).

  1. Click on the OK button to finalize the import.
  2. The following window will appear asking the user to either push the configuration to the specified device immediately or to cancel the configuration push.
Finalize Import

  • Only XML file format is supported for the uploaded custom configuration file.
  • If the file name does not meet MAC address format requirements, the import will fail. When uploading another configuration file for an existing device, the previous configuration file will be overwritten

Push Update

Click on the button for the desired device to manually push the configuration to it.

Push Update

Download Configuration File

Click on the button for the desired device to get its configuration file.

Delete CFG File

To delete uploaded configuration files from GDMS, select the desired devices in the list and click on the Delete button at the top left of the By CFG page.

Was this article helpful?

Related Articles

Need Support?
Can’t find the answer you’re looking for? Don’t worry we’re here to help!
Contact Support

Leave a Comment