Grandstream Networks, Inc.
COPYRIGHT ©2019 Grandstream Networks, Inc. http://www.grandstream.com All rights reserved. Information in this document is subject to change without notice. Reproduction or transmittal of the entire or any part, in any form or by any means, electronic or print, for any purpose without the express written permission of Grandstream Networks, Inc. is not permitted. The latest electronic version of this guide is available for download here: http://www.grandstream.
Table of Content DOCUMENT PURPOSE........................................................................................................... 15 CHANGELOG............................................................................................................................. 16 Version 1.0.0.65................................................................................................................................................. 16 Version 1.0.0.42.................................................
Device Parameters Configuration................................................................................................................... 35 View Device Details........................................................................................................................................... 36 Edit Device.......................................................................................................................................................... 38 View Device Operation Logs.....
Delete Account................................................................................................................................................... 63 Export Account................................................................................................................................................... 63 Edit SIP Server...................................................................................................................................................
Add Site............................................................................................................................................................... 79 Batch Import Sites..............................................................................................................................................80 Edit Site...............................................................................................................................................................
CHANNEL MANAGEMENT................................................................................................... 103 Superior Channel Binding Address............................................................................................................... 103 Add Sub-channel..................................................................................................................................... 104 Edit Subordinate Channel Customer........................................................
MFA Device Standards................................................................................................................................... 122 Download Virtual MFA APPlication............................................................................................................... 122 Enable MFA Device......................................................................................................................................... 123 Enable Virtual MFA Device........................
Table of Tables Table 1 : GDMS Technical Specifications...............................................................................................................18 Table 2 : Register GDMS Account...........................................................................................................................22 Table 3 : Supported Devices....................................................................................................................................
Table 25 : Message Notification Settings............................................................................................................... 99 Table 26 : Email Notification Settings................................................................................................................... 100 Table 27 : Track Device...........................................................................................................................................
Table of Figures Figure 1 : Welcome to GDMS.................................................................................................................................. 21 Figure 2 : Register GDMS Account......................................................................................................................... 22 Figure 3 : OverView...................................................................................................................................................
Figure 25 : Reboot Device........................................................................................................................................42 Figure 26 : Factory Reset......................................................................................................................................... 43 Figure 27 : Delete Device.........................................................................................................................................
Figure 51 : Delete Account....................................................................................................................................... 63 Figure 52 : Delete SIP Server.................................................................................................................................. 64 Figure 53 : Manual Configuration Push..................................................................................................................65 Figure 54 : Example – GXV3370.
Figure 77 : View Devices.......................................................................................................................................... 83 Figure 78 : Transfer Site........................................................................................................................................... 84 Figure 79 : Add Task..................................................................................................................................................
Figure 103 : Device Operation Options................................................................................................................108 Figure 104 : Assign Multiple Devices to Subordinate Channel........................................................................ 109 Figure 105 : Copy and Paste Multiple MAC Addresses.................................................................................... 109 Figure 106 : Import to Manage Device................................................
DOCUMENT PURPOSE This document introduces the GDMS platform and how to use it to manage various Grandstream products. Currently, GDMS supports GXV33xx series, WP820, GRP series, GXP21xx series, HT8xx series, DP7xx series and GVC3210. To learn more information about GDMS platform, please visit link www.grandstream.com to get more information.
CHANGELOG Version 1.0.0.65 New independent region: EU region (for GDRP rules) Support GRP26XX, DP7XX, GXP21XX, GXV3380/3370/3350, HT80X, HT81X, GVC3210,GRP2616. Add Sub-level organization feature. User's dashboard support statistic by sites. User's dashboard adds devices distribution Map. Add operation log for difference users and record the operation logs for each device. Support schedule recycle task. ACS server support load-balance.
WELCOME Thank you for using Grandstream Device Management System! GDMS is a cloud-based solution that provides the ability to easily manage Grandstream products before, during, and after deployment. GDMS separates subsystems independently based on different product lines: VoIP phone systems, PBX systems, network systems, and gateway systems. GDMS User Guide Version 1.0.0.
PRODUCT OVERVIEW Feature Highlights Intuitive deployment and management: GDMS’s easy-to-navigate web portal and batch operation support allow users to easily deploy and manage Grandstream devices located on several sites. All-in-one solution: GDMS offers a complete package that offers convenient management of devices and SIP server accounts on multiple sites, real-time monitoring and alerts, task scheduling and tracking, and device diagnostics. Supports presetting offline devices.
Security and HTTPS protocol and two-way certificate verification to ensure data security between devices and GDMS. Authentication The key information of devices is encrypted and stored so that the key information cannot be obtained from the data storage. The account password is encrypted and stored with sha256 algorithm to ensure the security of the account. Enterprise Features Serial number authentication of devices to ensure private rights of devices.
GETTING STARTED GDMS Overview Main Functions Overview Import devices and management Users need to import the devices into the GDMS platform first in order to view the status and configuration of the devices and monitor the devices on the GDMS platform. Channel vendors could acquire devices directly through ERP, and the channel vendors need to submit relevant certificates to Grandstream customer support.
Alarm message and diagnostic In case of malfunction or dangerous operation of the devices, the administrator will be alerted. The GDMS platform supports to allow the administrators to diagnose faults of some devices in order to locate and resolve problems quickly. Prerequisites TR-069 feature needs to be enabled on the endpoints. Working Internet connection to access GDMS platform. Endpoint devices are in the supported device list of GDMS platform.
2. Click on Sign Up option to enter the registration page, and then fill in the following information: Figure 2: Register GDMS Account Table 2: Register GDMS Account Region This option shows the user will be connected to which server. The data of the different servers are completely independent. The default setting is “United States”. Customer Type Select the customer type of the user. Available options are Provider, Reseller, System Integrator, and Enterprise User.
Time Zone Set up the current time zone Verification Code Enter the captcha displayed on the right of this field. 3. Once registration is complete, an account activation email will be sent to the configured email address. Follow the instructions in the email to activate the account and complete registration. Supported Devices and Requirements The current GDMS platform version supports the following device models.
OverView Device Statistics The Dashboard page provides an overview of the following information: Total accounts Total devices Total sites Accounts status Devices status Device Distribution Sites statistics Model statistics Figure 3: OverView GDMS User Guide Version 1.0.0.
Table 4: OverView Labels Module Description Total Accounts Displays the total number of SIP accounts configured on GDMS. Total Devices Displays the total number of devices configured on GDMS. Total Sites Displays the total number of sites configured on GDMS. Account Status Displays the total number of accounts currently registered, unregistered, and unallocated. Devices Status Device Distribution Normal: All devices which use this account are registered successfully.
Figure 4: Model Statistics Device Distribution This menu will show the distribution map of the devices which have been associated by the enterprise. The dark blue area on the map shows that area has more associated devices, and the light blue area shows the area has fewer devices. Users could leave the cursor on the area to check the amount of the devices in that area.
DEVICE MANAGEMENT The Device page shows all the associated devices. Users can view the information and status of the devices, the allocated account information, etc. GDMS platform supports to allow users to configure parameters, upgrade firmware, reboot/factory reset devices, view devices details, device diagnostics, and other operations. Figure 6: Device Management Table 5: Device Management Status Descriptions Status The device is offline.
The account registration credentials are incorrect The account was modified on the device No Account: GDMS platform does not allocate any account to the device. Last Config Synchronizing: If the account and device parameters were modified, the changes will Time immediately be pushed to the device. This status will be shown while this is happening. Date/Time: The date and time of the last successful provisioning. Call Status Idle: The SIP account is in idle state.
Add Device To add a new device to GDMS, click on the Add Device button. The following window will appear: Figure 8: Add Device Table 7: Add Device Device Name (Optional) This option is used to set the name of the device so that the users could identify this device. The maximum number of the input characters is up to 64. MAC (Required) This option is used to enter the MAC address of the device.
Batch Import Devices Users can import multiple devices by uploading a file. Click on the Import Devices button on the Device page to get started. The following window will appear: Figure 9: Import Device 1. Click on the button to download the template. Users must follow the instructions to enter the required information. Figure 10: Import Device Template 2.
000B82E21234, and it supports to fill “:” and “-” characters in this field. SN Users need to fill in the serial number of the device in this field (Required). Device Name This option is used to set the name of the device so that the users could identify this device (Optional). The maximum number of the input characters is up to 64. Site Name Enter the site to assign this device to (Required). If the site is under more than one level, all site levels must be included in the site name (e.g.
Figure 11: Configure SIP Account 3. On this Account Configuration page, users can select the SIP accounts created in the SIP Account page to assign to the device. 4. Users could also select to replace the existing SIP account for a specific account or delete the existing accounts. 5. Click on the Save and Apply button. The accounts will then be assigned to the device. Notes: If a device is offline during the account assignment, GDMS will sync any changes to it the next time it goes online.
2. After clicking the button, users will see the figure as shown below: Figure 12: Configure SIP Account for DP Devices Table 9: Configure SIP Account for DP Devices User ID Allocated: This SIP account has already been allocated to other devices; Unallocated: This SIP account has not been allocated to any device. Profile Different SIP servers cannot be set to the same profile. HS Mode If this field is not filled, the default setting is “Circular” mode. GDMS User Guide Version 1.0.0.
3. To configure the lines for each HS mode, click on the Line Configuration tab. Figure 13: Line Configuration Note: Set up a line account for each handset and select the SIP accounts from the configured accounts in the device. 4. Select the desired SIP accounts to use for each line and handset. 5. Click on the button Save and Apply to allocate the SIP accounts or lines to the devices.
Device Parameters Configuration Users can modify the configuration parameters for a single device. 1. In the device list, click on the button to go to the Device Parameters Configuration page, as shown in the figure below: Figure 14: Device Parameter Configuration a. Clicking on the Select All button will select every option on the current page. Clicking on it again will deselect all the options. b. Clicking on the Reset Settings button will restore all settings on the current page to default values. 2.
Figure 15: Edit Configuration File a.The format requirement is: key=value. Key can be either a P-value or an alias. b.Users can enter the latest parameters and values of a device in the text editor even if the GDMS configuration page does not display the configuration options. 3. Click on the Save and Apply button to finalize changes. Only settings that are checked will be pushed to the device.
Figure 16: View Device Details The device details include System information, Network information, Account status, and etc. Figure 17: Device Details Note: The information in this page is obtained from the device in real-time. If the device is offline, the details page will be inaccessible. GDMS User Guide Version 1.0.0.
Edit Device Users could edit the Device name and which site the device belongs to. 1. In the device list, click on the button which is following the device, and select Edit Device to access to the device editing page. Figure 18: Edit Device Option 2. Users will see the device editing page as the figure shows below: Figure 19: Edit Device GDMS User Guide Version 1.0.0.
3. Click on Save button to apply the changes on the GDMS platform. View Device Operation Logs Users could view all operation logs for a specific device on the GDMS platform. 1. On the Device List, select the menu button following the specific device, and click on “Operation Log” button. 2.
Figure 21: View Device Task History Firmware Upgrade Users could upgrade firmware for a batch of devices to a specific firmware version. 1. In the device list, check multiple devices, and then click on button Upgrade Firmware on the top of the Device page. Figure 22: Upgrade Firmware 2. Users need to select the firmware version to upgrade to. 3. Task Time: Select when to start the firmware upgrade. Users can choose to upgrade immediately or to schedule the firmware upgrade for a specific time. 4.
navigating to the Task Management page. Notes: Users cannot batch upgrade different device models or models on different firmware If the desired firmware is not available, users will need to contact their GDMS administrator. Site Assignment Users could edit the site of a batch of devices on the GDMS platform. The default site is “default”. 1. Select the desired devices and click on the Site Assignment button. Figure 23: Site Assignment 2. Select the site to assign the selected devices to. 3.
Figure 24: Move Device 2. Select the target organization where to transfer the device. 3. The user needs to select whether to clone SIP account and server which have been configured in the devices. If the user selects “No”, only the device data are transferred to new organization, the configured SIP accounts become empty after moving the devices. Reboot Device Users could reboot one device or a batch of devices on the GDMS platform. 1. Select the desired devices and click on More Reboot Device.
Factory Reset Users could factory reset one device or a batch of devices on the GDMS platform. 1. Select the desired devices and click on More Factory Reset. Figure 26: Factory Reset 2. Task Time: Select when to factory reset the device. Users can choose to factory reset the device immediately or to schedule the factory reset for a specific time. 3. Click on the Save button to create the task. Users can check the status of the reboot by navigating to the Task Management page.
Figure 27: Delete Device 2. Click on OK button on the pop-up window to confirm deleting the devices, and the selected devices will be deleted immediately from the GDMS platform. The timing tasks involve the deleted devices will be canceled either. Figure 28: Delete Device Prompt Export Device To export the entire device list, click on the button in the top-right corner of the device list page. The exported list includes all device and account information. GDMS User Guide Version 1.0.0.
FIRMWARE MANAGEMENT Custom Firmware Users could upload the firmware of the devices to upgrade the associated devices on the GDMS platform. Note: It is recommended to download the device’s firmware from Grandstream Official website in order to avoid devices failure. 1. On the Custom Firmware page, click on the Upload Firmware button. 2. Either drag and drop the firmware file to the upload area or enter the firmware file path.
Firmware Name This is used to identify the firmware file name. The limit is 1 - 64 characters. Version Number Fill in the actual version number of the uploaded firmware. Supported Model Select the supported device models of the firmware. Description Description of the firmware. Maximum character limit is 256. 3. Once the firmware is uploaded successfully, it will appear in the custom firmware list. Devices will be able to select the firmware when upgrading via GDMS.
Figure 31: Official Firmware Note: Official firmware cannot be edited or deleted, and users can only download or push the firmware to upgrade the devices. Firmware Update Notification Settings Users can subscribe to firmware update email notifications to keep up-to-date with the latest firmware releases. 1. Click on the New Version Notification Settings button at the top of the Firmware page. The following window will appear: GDMS User Guide Version 1.0.0.
Figure 32: Firmware Update Notification Settings 2. Users can select the device models they want firmware update notifications for. 3. Click on the Save button to finalize changes. Push to Upgrade Firmware Users could push the upgraded firmware to the devices directly, or the devices in a range of firmware versions. GDMS User Guide Version 1.0.0.
1. Click on the button for the desired firmware. The following window will appear: Figure 33: Push to Upgrade Firmware 2. Select the devices to push the firmware to. Users can search for specific devices by entering in a MAC address or name or filter devices by specific sites. 3. Click on Update Now to immediately push the firmware upgrade to devices or Schedule Config Update. 4. Click on the Save button to create the task. Users can check the status of the firmware upgrade in the Task Management page.
Note: If a firmware on GDMS is using a configured file path, that path will be used when downloading it. Delete Firmware Users can delete firmware by selecting them in the firmware list and clicking on the Delete button in the top-left corner of the list. Note: If a firmware is deleted, scheduled tasks associated with it will continue as normal anyways. Once all associated scheduled tasks are completed, the firmware file will automatically be removed from GDMS. GDMS User Guide Version 1.0.0.
ACCOUNT MANAGEMENT Overview On the Account Management page, users can manage SIP accounts across all configured SIP servers in GDMS, import a list of accounts for quick setup, and export a list of all accounts configured on GDMS. Figure 34: Account Management Table 11: Account Status Description Status Description Status Normal: All devices using the account are registered, and the account is working normally. Abnormal: At least one device using this account is not registered.
Table 12: Operation Description Operation Sorting Descriptions Click on the buttons to sort the list in ascending/descending order based on a specific column. Custom Display Users could customize the displaying options on the list by clicking on option on the Option right side of the list to select the displayed/hided options. Filter and Filter accounts by status, site and search for specific accounts by entering in their user Search IDs, account names, or display names.
server. This should be provided by VoIP service provider (ITSP). Outbound Proxy Configures the IP address or the domain name of the primary outbound proxy, media gateway or session border controller. It's used by the phone for firewall or NAT penetration in different network environments. If a symmetric NAT is detected, STUN will not work and only an outbound proxy can provide a solution.
symmetric type. If set to “Keep-alive”, the phone system will send the STUN packets to maintain the connection that is first established during registration of the phone. The “Keep-alive” packets will fool the NAT device into keeping the connection open and this allows the host server to send SIP requests directly to the registered phone. If it needs to use OpenVPN to connect host server, it needs to set it to “VPN”.
Figure 36: Finish Adding SIP Server to GDMS Add SIP Account The SIP Account page shows all of the SIP accounts added to GDMS. Figure 37: Add SIP Account Table 14: Add SIP Account Account Name This is a necessary option. Specifies an identity name for the SIP account. SIP Server This is a necessary option. Users need to select the SIP server for the SIP account. If there is no available SIP server for the current SIP account, users could GDMS User Guide Version 1.0.0.
click on “Add Server” option to add a new SIP server for the SIP account. SIP User ID This is a necessary option. Configures user account information provided by your VoIP service provider (ITSP). It's usually in the form of digits similar to phone number or actually a phone number. SIP Authentication This is a necessary option. Configures the SIP service subscriber's Authenticate ID ID used for authentication. It can be identical to or different from the SIP User ID.
Figure 38: Allocate to Devices Table 15: Allocate to Devices Select Device This is a necessary option. Users need to select the device model which the account Model will be allocated to. Select Device This is a necessary option. Users need to select the device MAC address which the MAC Address account will be allocated to. Select Account This is a necessary option. Users need to select the account index which the Index account will be allocated to (e.g. Account 1 – Account 16).
Batch Import SIP Account GDMS platform supports to allow users to import a batch of SIP accounts and SIP servers to the system and allocates to the devices via Excel files. 1. On the SIP Account page, click on the Import Account button. The following window will appear: Figure 39: Import SIP Account 2.
Figure 41: Import Account Template – DP Device Template Figure 42: Import Account Template - HT Device Template Table 16: Import Account Template Options Account Name This is an optional option. Users need to set the identity name for the SIP account. SIP Server This is a necessary option. Users need to input the SIP server address. If the SIP server does not exist in the GDMS platform, the GDMS platform will create the SIP server in the system. SIP User ID This is a necessary option.
Device MAC Input the device MAC address: e.g. 00-15-65-1A-2B-3C; 00:15:65:1a:2b:3c; Address 0015651a2B3c Account Index Users need to select the account index which the account will be allocated to (e.g. Account 1 – Account 16). If the current account location has a configured account, the configured account will be replaced with the new account information. Profile For DP devices and HT devices only. Enter the profile that the account will use (e.g. Profile1, Profile2, etc.).
Figure 43: Example I 2. For the existing SIP account, if the user wants to allocate this SIP account to another device, here is the example: Account 100 has been allocated to Device 1, and the user wants to allocate the SIP account 100 to Device 2 (00:aa:bb:cc:dd:ee). Figure 44: Example - II 3. If the user wants to allocate multiple SIP accounts to a single device, here is the example: Figure 45: Example III 4.
Allocate Device Users could allocate the SIP accounts to the devices during adding SIP accounts, editing SIP accounts, or importing a batch of SIP accounts to the GDMS platform. Each SIP account can be allocated to multiple devices. Edit Account Users could edit the SIP account information and allocated devices on Edit Account configuration page. 1. Click on the button for the SIP account you want to modify. Figure 50: Edit Account 2. Click on the Save button to finalize changes.
Delete Account To delete SIP accounts on GDMS, click on the button for a single account or the Delete button in the top-left corner for multiple accounts. Associated devices will automatically remove deleted SIP account information. Users could delete 1 single SIP account or a batch of SIP accounts on the GDMS platform: Figure 51: Delete Account Note： If the SIP account is synchronized from UCM server, this will only delete the data in GDMS platform, and the data in UCM server will not be deleted.
Delete SIP Server Users can delete selected SIP servers by selecting them in the SIP server list and clicking on the Delete button in the top left corner of the SIP Server page. Figure 52: Delete SIP Server Note： If the SIP server is synchronized from UCM server, this will only delete the data in GDMS platform, and the data in UCM server will not be deleted. GDMS User Guide Version 1.0.0.
DEVICE CONFIGURATION 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. Additionally, users can upload configuration files for individual devices and manage them individually. By Model Users could customize the configuration template and classify the templates by device model and site.
Note: 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.
Figure 55: Add Template Table 17: 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.
template. Notes: 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.
Figure 56: Set Parameters Clicking on the Select All button will select every option on the current page. a. Clicking on it again will deselect all the options. Clicking on the Reset Settings button will restore all settings on the current page b. to default values. 2. 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.
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. 1. Select a specific configuration template, click on the button following the template. Figure 57: Push Configuration File 2. Users could select any device in this device model to push the configuration template, the device will be updated with the configuration template.
Management page. Edit Template To edit the configuration template’s name, site, and description, click on the button for the desired template. Figure 59: Edit Model Template Download Configuration Template To download the configuration template of a device model, click on the button for the desired template.
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. Figure 61: Delete Template 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.
1. Click on the Add Group button at the top right of the By Group page. Figure 63: Add Group Table 18: Add Group Group Enter the name of the group to easily identify it. Names must be unique and have a Name maximum character limit of 64. Type Users need select the type: Audio phone series: This is used to configure the common configuration parameters of GXP and GRP series. Description 2. DP series: Use the configuration template for DP7xx series.
Selected devices will be moved to the Selected Device list on the right of the page. Figure 64: Finish Adding Group 3. Users could click on “Prev” button to go back to the group configuration page to re-edit the group information. Click on the Save button to complete group member selection. Users will then be redirected to Set 4. Parameters page. Note: Users need to set the parameters of the configuration template for the newly added group.
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.
4. 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. Figure 66: Edit Group 2. Modify the desired settings and click on the Save button to finalize changes. Note: 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.
their specified device. Figure 68: 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: Figure 69: Upload CFG File 2. Drag and drop the file to the window or click on the upload icon to select a file from your PC. Note: GDMS User Guide Version 1.0.0.
The uploaded file must be named as the device’s MAC address (e.g. 000b82afd0b0.xml). 3. Click on the OK button to finalize the import. 4. The following window will appear asking the user to either push the configuration to the specified device immediately or to cancel the configuration push. Figure 70: Finalize Import Notes: 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.
SITE MANAGEMENT Site Management allows users to organize their devices by sites and categories. Figure 72: Site Management Add Site Users could add a site at any time on GDMS platform. 1. Click on the Add Site button at the top right of the Site Management page. To quickly add a sub-site under a specific site, click on the button next to the desired site. Users can create a total of 7 different levels of sites. GDMS User Guide Version 1.0.0.
Figure 73: Add Site Table 19: Add Site Site Name Enter a name for the site to easily identify it. Sites on the same level cannot have the same name. Superior Site The parent level of the site. This field can be left blank if the created site is a top-level site. Site Enter the descriptions of the site. Description 2. Once the site is created, users can then assign devices to it. Batch Import Sites Users could import a batch of sites into GDMS platform. 1.
Figure 74: Import Site 2. Click on the Download button to get a template that will be used to import site information. Figure 75: Site Template GDMS User Guide Version 1.0.0.
Table 20: Site Template Options Site Name Enter the name of the site. If the site is the child of another site, users must enter the entire path (e.g. top-level site/second level site/third level site/…new site name). Description Enter the descriptions of the site. 3. Once the template is filled out, drag and drop the file to the upload window or select the file from your PC. Click on the Import button to confirm the import. 4.
Figure 76: Edit Site Delete Site To remove a site from GDMS, click on the button next to the desired site. Note: If the selected site has devices assigned to it, the site cannot be deleted unless the devices are assigned to another site beforehand. View Devices To view all the devices under a specific site, click on the desired site in the Site Management list. Figure 77: View Devices GDMS User Guide Version 1.0.0.
Transfer Site Users can select devices in a site and move them to another site by clicking on the Move button. Figure 78: Transfer Site Clicking on the Save button will finalize the move to the specified site. GDMS User Guide Version 1.0.0.
TASK MANAGEMENT The Task Management page displays all queued and completed tasks in GDMS such as configuration pushes, firmware upgrades, reboots, and factory resets. Users can add, edit, and delete tasks from this page. Add Task To add a task to GDMS, click on the Add Task button. Figure 79: Add Task Table 21: Add Task Task Name Enter the name of the task. Task Type Immediate: The task will be run immediately. If the task is not run after 5 minutes, GDMS will automatically close it.
Task Contents Reboot Device Factory Reset Upgrade Firmware: Users will need to select the device model and firmware version to upgrade to. Update Config: Model: Select the model template that will be used for the configuration update push. Update Config: Group: Select the group template that will be used for the configuration update push. Upgrade Method This option is available only when Upgrade Firmware is selected as the Task Type.
Figure 80: Task Management List Notes: If there are multiple tasks for 1 device, they will be queued up to run in order of their configured start time. If a device is offline, pending tasks associated with the device will be run the next time the device is offline. Certain tasks and device setting changes can cause a device to reboot. Firmware upgrade tasks may require more time to run due to the size of some firmware files.
Figure 81: View Task Status Table 22: Task Status Description Pending The task has not been executed yet. Executing The task is currently in progress. Success The task has completed successfully. Failed The task has failed. Canceled The task was cancelled. Timeout The task was not executed when it arrives the ending time. Ended The task was ended before it could be completed. Some of the involved devices may not have run the task before it ended.
Users can view the task status of each device involved. Figure 82: Task Status Table 23: Task Status Detailed Description Pending The task has not been run yet. Executed Executing The task is currently ongoing. Success The task has been completed successfully. Failed The task has failed. A failure reason will be shown. Timeout The task has been sent to the device, but the device has not responded yet.
Start Scheduled Tasks Users can start pending scheduled tasks immediately by clicking on the button. Cancel Pending Tasks To cancel a pending task, click on the button for the desired task. The task status will be changed to Cancelled. To run the task again after it’s completed, click on Task Details -> Run Again for the desired task. If the task is a recurring task, users could select whether to cancel the entire recurring task or just cancel the single task.
Figure 83: Search Task Delete Task Users can delete tasks at any time. Select one or more tasks and click on the Delete button at the top of the page to delete them. Note: When deleting ongoing tasks, GDMS will automatically suspend and delete them. Any changes made before the task was suspended cannot be undone. GDMS User Guide Version 1.0.0.
DEVICE DIAGNOSTICS Device Diagnostics allows users to check devices on GDMS for issues, view device information, obtain network captures and syslog, and conduct traceroutes. Start Diagnostics To start diagnosing a device, users can do one of the following: 1. Enter the device’s MAC address and click on the Start Diagnostics button. 2. Click on the button for the desired device in the list to diagnose the device.
Figure 85: View Diagnostics Details Notes: If the device is offline, users cannot diagnose this device on GDMS platform. Devices that are currently being diagnosed by a user cannot be diagnosed by other users. View Device Details Click on the button on the right of the Device Diagnostics page to view information about the device. GDMS User Guide Version 1.0.0.
Figure 86: View Device Details Ping/Traceroute Clicking on the Ping/Traceroute tab in the Device Diagnostics page will show the following: Figure 87: Ping/Traceroute Table 24: Ping/Traceroute Options Operation Method Ping: Checks the connection status and speed between the device and the target host. Results include packet loss information, maximum/minimum data packets size, and the round-trip time of the packets. GDMS User Guide Version 1.0.0.
Traceroute: Displays the route and transit delays of packets from the device to the target host. Up to 30 hops can be monitored. Target Enter the IP address or hostname of the target host. Host Users could click on “Start” button, wait for the GDMS system to diagnose the device, and the GDMS platform will print out the diagnostics results. Each operation prints the diagnostics result once, and users could operate the diagnostics for multiple times.
Capture Trace Users can get Capture Trace tool allows users to get a network packet capture of a device. 1. Click on the Start button to start the packet capture. 2. Click on the Stop button to end the packet capture. 3. Click on the button to download the capture file. Notes: GDMS can only capture up to 5 minutes. An ongoing capture will end automatically after 5 minutes. Some models do not support to capture the trace file remotely.
Figure 90: Diagnostics Records 1. If a device is currently being diagnosed, click on the button to continue diagnosing or the button to end it. 2. If a device has been diagnosed already, click on the the button to start another round of diagnosis or button to view the results. 3. View the diagnostic history of a specific device by using the search bar on top right of the Diagnostic Records page. 4. Users can delete records by selecting one or more items and clicking on the Delete button.
ALERT MANAGEMENT GDMS has an alert system that will trigger when certain conditions are fulfilled. There are 3 alert levels: High, Medium, and Low. Alert Notification Settings Users can view and receive alert notifications in two ways: Message Notification and Email Notification. Message Notification Settings This displays the alert as a notification under the icon in the top right corner of the GDMS page. 1.
Table 25: Message Notification Settings Alert Details Users can specify what alerts to receive. The following alert priority levels are available: High Level: Account Registration Failure Medium Level: Factory Reset Task Run Failure (users can specify the tasks they want notifications for) Device Offline Low Level: Device Reboot Subscriber Select the users that will be alerted. Only sub-users created by current user can be selected.
Figure 93: Email Notification Settings Table 26: Email Notification Settings Alert Details Users can specify what alerts to receive. The following alert priority levels are available: High Level: Account Registration Failure Medium Level: Factory Reset Task Run Failure (users can specify the tasks they want notifications for) Device Offline Low Level: Device Reboot Subscriber Select the users that will be alerted. Only sub-users created by current user can be selected.
2. When the subscriber receives the alarm notification, the GDMS platform will send an email to inform the subscriber. In order to avoid the alarm notification emails disturbing the subscriber, the GDSM platform only can send one alarm notification email to the subscriber’s email box per hour. Figure 94: Email Alert Notification View Alert Notification The Alert Management page shows all alerts that have been generated by GDMS.
Figure 95: View Alert Notification Search: Users can find specific alerts by using the filter and search features in the top right corner of the Alert Management page. Latest alarm notification: If the alarm notification includes a red dot at the beginning of the item, it means the alarm notification is an unread notification. Users could click on the button to mark all unread notifications as “Read”.
CHANNEL MANAGEMENT Channel customers and service providers can obtain a list of purchased devices from Grandstream ERP. This list will allow the channel customer or service provider to: 1. Quickly assign devices to sub-channel customers. These customers will then be able to log into GDMS to manage the devices. 2. Manage devices directly for customers. Note: Channel customers and service providers will need to contact Grandstream support to associate their GDMS account with an ERP account.
Figure 97: Superior Channel Binding Address • Copy: Click to copy the link address to the clipboard. • Reset Address: Generate another address. The previous link will be invalid. Add Sub-channel Users can add sub-channels’ GDMS accounts at any time. Once added, the user can assign devices to the sub-channels. To properly add a sub-channel: Obtain the bind address from sub-channels to add their GDMS accounts. 1. On the Channel Management page, click on the Add Sub-channel button.
2. Enter the provided bind address from the sub-channel into the Link Address field. 3. Add a description or comment for this sub-channel. 4. Click on the Save button to finalize changes. 5. Once the sub-channel is added, users can now assign devices to it via the Trace Devices tab. Notes: Each user could be the subordinate channel customer for multiple GDMS users. Each user could be the superior channel distributor for multiple GDMS users.
Delete Subordinate Channel Customer To remove sub-channels from GDMS, select the desired sub-channels and click on the Disassociate button. Devices can no longer be assigned to this sub-channel. Figure 100: Disassociate Sub-channel Track Device View Device To view all devices assigned to the account, click on the Track Device tab. Figure 101: Track Device GDMS User Guide Version 1.0.0.
Table 27: Track Device MAC Address The MAC address of the device. Device Model The model of the device. Resource Where the device originated from. Currently there are two values: 1. ERP Order – The device’s data was synced from Grandstream ERP. 2. Main Channel – The device was added by the main channel. Warehousing The date/time the device was assigned to the account. Time Status Allocated: The device has been assigned to a sub-channel and cannot be assigned to other sub-channels.
The user could allocate a single device or allocate a batch of devices: Assign a Single Device: 1. Click on the button for the desired device. The following window will appear: Figure 102: Assign Single Device to Subordinate Channel 2. Select the sub-channel to assign the device to. Assign Multiple Devices: 1. Click on the Device Operation button at the top-right of the Channel Management page. 2. Click on Assign to Subordinate Channel on Track Device page.
Figure 104: Assign Multiple Devices to Subordinate Channel Table 28: Assign to Subordinate Channel Select Subordinate Select the sub-channel to assign the devices to Channel Customer Device Select the devices to assign to the sub-channel from the list or enter the MAC addresses of the devices. Figure 105: Copy and Paste Multiple MAC Addresses 4. Click the Save button to finalize changes and the assignment. The sub-channel will then be notified of the device assignment. GDMS User Guide Version 1.0.0.
Notes: 1. The device which has been allocated to a customer cannot be allocated to any customer else. 2. When the device is allocated, the user cannot acquire back the device. If the device is allocated to a customer incorrectly, the user could contact the subordinate channel customer to allocate the device back to the user. Configure Device To manage devices from the Channel Management device list, users must first import the devices to GDMS Device Management. Import Single Device 1.
USER MANAGEMENT The User Management page allows users to view, add, and edit users and manage role privileges. By default, GDMS has one administrator, which has all available privileges. Roles are sets of privileges that admins can assign sub-users.
Edit Role To edit a role’s name, description, and privileges, click on the button for the desired role. Note: Users cannot edit the roles of the default admin account. Delete Role To delete a role, click on the button for the desired role. If the role includes some sub-users accounts, the role cannot be deleted.
verify and activate this account, log into GDMS, and receive email notifications. Role Users need to select the role of the sub-user. Manageable Assign the manageable organization to the user, and the administrator could select the Organization manageable organizations from the existing organizations. Upon creating the sub-user, an activation email will be sent to the configured email address. The sub-user must click on the provided link to activate the account.
Personal Information Users can view and edit their personal information on GDMS by clicking on their name in the top-right corner of the GDMS portal and clicking on Personal Information. Figure 111: Personal Information Table 31: Personal Information Name This option shows the display name for the account. Email Address This option shows the email address associated with the account. To modify this email address, the user will need to enter the current login password.
Sign Out Log out of the account by clicking on the username on the top-right corner of the GDMS portal and click Sign Out. Figure 112: Sign Out GDMS User Guide Version 1.0.0.
ORGANIZATION MANAGEMENT If users want to manage devices in multiple subordinate organizations, users could create multiple organizations (such as customer enterprises, sub-companies), and assign the devices to multiple users to manage separately. The devices, SIP accounts, and other parameters are separated between different organizations. The data in a specific organization can only be viewed and managed by the administrator who has the permission.
Figure 114: Switch Organization Add Organization The user could create an organization if the user has the permission. 1. On the menu at the right side of the page, select System Management User Management, and select the “Organization” tab, click the “Add Organization” button at the upper right corner. 2. Fill in the information of the organization as shown in the following figure: GDMS User Guide Version 1.0.0.
Figure 115: Add Organization Table 32: Add Organization Organization Name Input the name of the organization. Assign User Select the users who will have the permission to manage the organization. Clone Organization This is used to select to copy data from other organizations, the data include SIP accounts, model templates, group templates, sites, etc. When the organization is created successfully, the data under the specific organization will be copied to the current organization.
1. On the menu at the right side of the page, select System management -> User Management, and select the “Organization” tab to view all organizations under the account. 2. Click on the button following the organization name to access to the editing page. The user could edit the organization name, the administrator of the organization, and descriptions, as the figure shows below: Figure 116: Edit Organization Delete Organization 1.
SYSTEM LOG Users could view all operation logs of the system, including the login/logout logs of the user, adding new devices, deleting devices, adding SIP accounts, deleting SIP accounts, firmware upgrading/downgrading logs, updating configuration files for devices, devices factory reset logs, devices diagnostics logs, creating model template logs, and etc. On menu at the right side of the page, select System management -> System Log, and users could view all operation logs of the system.
MULTI-FACTOR AUTHENTICATION GDMS Multi-Factor Authentication (MFA) is the simple and best security practice method that adds an extra protection to account username and password. When MFA is enabled, the user will be required to enter the login username and password (the first security method) and an authentication code (the second security method) from the MFA device when they log on to the GDMS platform. These multiple methods will improve the security for the settings and resources of your GDMS account.
physical MFA device assigned to the user must be unique. The user cannot type in the code with another user's physical MFA device code for authentication. MFA Device Standards Table 33: MFA Device Standards Virtual MFA Device Physical MFA Device MFA Device Refer to table 2 Purchase physical MFA device Cost Free Price by supplier Physical Device Use your smartphone/tablet/PC The physical device which supports Standard which can execute applications that open TOTP standards.
Enable MFA Device To enhance security, it is recommended that users can configure Multi-Factor Authentication (MFA) to help protect GDMS resources. Users can enable MFA for GDMS accounts. Enable Virtual MFA Device Prerequisite: Users need to install virtual MFA application on the smartphone/tablet/PC before enabling virtual MFA device. 1.
3. Then, it will generate and display the configuration information of the virtual MFA device, including QR code graphics. This figure represents the configuration of the virtual MFA device as a secret key, users can scan the QR code to finish setting virtual MFA device. Users can also input the secret key manually into the smartphone/tablet/PC in order to finish setting virtual MFA device if your smartphone/tablet/PC does not support to scan QR code. Figure 119: Scan QR Code 4.
select the camera icon or scanning QR code option to use the device's camera to scan the QR code. b. If the smartphone/tablet/PC does not support to scan QR code, the user can click on “show secret key” option and input the private secret key manually in the MFA application. Note: If a virtual MFA application supports multiple virtual MFA devices or accounts, the user can select the appropriate options to create new virtual MFA devices or accounts. 5.
6. Click on “Start Verification” option to start to verify the password. When the verification is pass, the GDMS account and the virtual MFA device has been bound successfully. When the user tries to log in the GDMS platform, the user must input the MFA device code. Note: 1. When the secret code is generated, the user needs to use the secret code to proceed verification process immediately.
Figure 121: Hardware MFA Device Authentication 4. Input the secret key of the device. Please contact with the manufacturer for the secret key. Note: The key format is required to be “DEFAULT HEX SEEDS” (seeds.txt), or “BASED32 SEEDS”. Examples: HEX SEED: B12345CCE6DA79B23456FE025E425D286A116826A63C84ACCFE21C8FE53FDB22 BASE32 SEED: WNKYUTRG3KE3FFTZ7UIO4QS5FBVBC2HJKY6IJLCP4QOH7ZJ12YUI==== 5.
box Code 2. Figure 122: Physical MFA Device 6. Click on “Start Verification” option to start to verify the password. When the verification is pass, the GDMS account and the physical MFA device has been bound successfully. When the user tries to log in the GDMS platform, the user must input the MFA device code. Note: 1. When the secret code is generated, the user needs to use the secret code to proceed verification process immediately.
2. Click “Remove” button to remove the MFA Authentication function for the current GDMS account. Lost MFA Device/Invalid MFA Device If your MFA device is lost or does not work properly, you can remove the MFA device first and then re-enable the new MFA device. Method 1: If your GDMS account is a sub-account, you can contact the main GDMS account to remove your multi-factor authentication from the User management page.
APPLY FOR API DEVELOPER GDMS platform opens API interfaces for public users. Users can apply for API Developer to use the services. Users can click to view the details about API interfaces. API document access address: https://doc.grandstream.dev/GDMS-API/ 1. Click on “API Developer” on the menu on the left side and click to apply for API Developer. Figure 123: API Developer 2.
3. If the user wants to disable API Developer feature, the user can click on “Disable API Developer” to stop invoking the API interfaces. Note: 1. Call API Address: The API Address is: https://{gdms_domain}/oapi/xxx If your GDMS account is in US region, the {gdms_domain} can be filled with www.gdms.cloud If your GDMS account is in EU region, the {gdms_domain} can be filled with eu.gdms.cloud 2.
ABOUT GDMS Users can view GDMS system information, supported device models, and firmware requirements for device models by clicking on System Management About GDMS. Figure 125: About GDMS GDMS User Guide Version 1.0.0.
EXPERIENCING GDMS.CLOUD SYSTEM Please visit our product website at http://www.grandstream.com for the latest release, features instructions, FAQs, latest documentations, and latest products information. We encourage you to browse our product related documentation, FAQs and User and Developer Forum for answers to your general questions. If you have purchased our products through a Grandstream Certified Partner or Reseller, please contact them directly for immediate support.
