Digi Remote Manager 3.0 User manual

Digi Remote Manager

Version 3.0

Help

Revision history—Digi Remote Manager 3.0 Help

Date Description

February2021 See What's new in February 2021 for details.

Trademarks and copyright

Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.

Disclaimers

Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose. Digi may make improvements and/or changes in this manual or in the product(s) and/or the program(s) described in this manual at any time.

Warranty

To view product warranty information, go to the following website:

www.digi.com/howtobuy/terms

Customer support

Gather support information: Before contacting Digi technical support for help, gather the following

information:

Product name and model Product serial number (s) Firmware version Operating system/browser (if applicable) Logs (from time of reported issue) Trace (if possible) Description of issue Steps to reproduce

Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support.

Feedback

To provide feedback on this document, email your comments to

Digi Remote Manager 3.0 Help

techcomm@digi.com

Include the document title and part number (Digi Remote Manager 3.0 Help, 90002349 A) in the subject line of your email.

Digi Remote Manager 3.0 Help

Contents

Welcome

What's new in February 2021 7

New features 7 Enhancements 8

Resolved issues 9 About Digi Remote Manager 10 Quick start 10 Menus and icons 10 Search and filters for lists 13

Simple search 13

Advanced filter 13 Export data as CSV 15 Copy device ID to clipboard 15 Select table spacing 15 Select how to display device ID 16 User menu options 16 Subaccounts menu 17

Dashboard

Connection status 18 Health status 19 Alerts 20 Signal strength 21 IPsec status (1-4) 21 Inventory status 21 Customize your dashboard 21

Devices

Add or remove device list columns 23 Export device list to CSV 24 Show devices on map 24 Add a device 24 Remove a device 25 Refresh device information 25 Reboot a device 25 Ping a device 25 Update device firmware 26 Turn on/off maintenance mode 26

Digi Remote Manager 3.0 Help

View and edit device details 27

Edit device configuration 28

View device summary dashboard 28

View and manage device files 29

Use a device console 29

View configuration scan history 30 Organize devices: groups, tags, and notes 30

Device groups 30

Device tags 30

Device notes 30

Create device groups 31

Add devices to a group 31

Edit a device group name 31

Remove a device from a device group 32

Show or hide device groups 32

Add or edit device tags 32

Add or edit device notes 32

Configurations

Configurations, device types, and groups 33 When are devices scanned? 34 Create a configuration 35 Include device overrides in a configuration 38 Include file systems in a configuration 38 Schedule automatic scans 38 View configuration status 39 View configuration scan history for a device 40

Alerts

View alert details and alert definition 41 View the status history of an alert 43 Acknowledge an alert 43 Reset an alert 43

Activities

Job details 44

Users

User roles 45 User information 45 Add a user 46 Edit a user 46 Change password 47 Remove a user 47

API explorer

Get a list of available v1 APIs 47

Digi Remote Manager 3.0 Help

Get an API summary 48 Copy and paste a device ID 48 Get help 49

Previous release notes

What's new in November/December 2020 50

New features 50

Enhancements 50

Security issue 51

Resolved issues 51

November hotfix 52

December hotfix 52 What's new in August 2020 52

New features 53

Enhancements 53

Resolved issues 54 What's new in June 2020 55

Features and enhancements 55

Known issues 56

Resolved issues 56

Security-related issues 56 What's new in October 2019 56

Display device configuration as a tab in Device Details view 56

Improved search options: simple and advanced 57

Display the total number of selected items within all table displays 57

Replaced column text headings with icons 57

Added export options for table views 58

Added options for custom table spacing 58

Added toggle for device ID display in tables: friendly or full 59

Digi Remote Manager 3.0 Help

Welcome

It’s Official! Welcome to the new Digi Remote Manager®!

We are taking the Digi RM platform to the next level with a focus on usability, functionality, and management, so that you can focus on your business needs. Here you will see all the new features for the Digi RM Platform. The classic UI has not gone away. You still have the ability to use the classic UI by clicking your username in the upper right-hand corner and then clicking Open Classic Remote Manager.

Click What's new in February 2021 for details on what's new in this release. Click Quick start for a walk-through of the new Digi Remote Manager.

What's new in February 2021

Welcome to the new Digi Remote Manager®! We've focused on Remote Manager usability and functionality so you can focus on your business needs. You can, however, still use classic Remote Manager:Click your username in the upper right-hand corner and select Open Classic Remote Manager.

This release provides features, enhancements, and general fixes. There are no security-related fixes in this release.

New features

Enhancements

Resolved issues

New features

n Sub-account views: If you are a primary account user, you can remove subaccounts and

identify the account owner.

n Automations: Create custom tasks and scripts for target devices to run immediately or on a

custom schedule. See the results of the automations as a quick summary or drill down for details.

n Useability enhancements and fixes: We've incorporated customer feedback to continually

improve your Remote Manager experience. To provide feedback to our team, click on your username in the upper right, and select Feedback.

Digi Remote Manager 3.0 Help

Welcome What's new in February 2021

Enhancements

n Added ws/v1/automations web services to create, update, and delete automations, scheduled

automations, as well as retrieve run results. In the API Explorer, use GET ws/v1/automations to see all automations web services. Note that if an account does not include the Device Automations service or the service has ended, all scheduled automations are automatically disabled.

n Automation steps are referenced by 1-based indexing, so step 1 is the first step.

n An automation can sleep (or pause) for a maximum of 3 days.

The sleep step accepts a “value” parameter of the form “2s”, “2m”, “2h” or “2d” to sleep for 2 seconds, minutes, hours or days respectively. If no suffix character is used, the sleep value is interpreted as seconds.

n Use automations to manage a subset of device properties: tags, description,

notes, maintenance_mode, and group.

n Exposed additional parameter for RCI cache step in automations (cache_mode)

to allow selectable cache behavior with values of: use_cache, ignore_cache, cache_only. The RCI step uses the ignore_cache mode by default so requests go to the device.

n Added the DELETE /ws/v1/subaccounts/inventory/{id} web service to delete subaccounts. By

default, devices within a subaccount are moved to the parent account. You can delete devices when you delete a subaccount using the delete_devices parameter.

DELETE /ws/v1/subaccounts/inventory/{id}?delete_devices=true

If devices exist in the subaccount, the default action is to move them to the parent account. To delete them instead, specify delete_devices=true.

Note that the DELETE /ws/v1/subaccounts/inventory/{id} web service starts a background job. The web service returns a context_id HTTP header. Use the value of the context_id header to query the context_id field of /ws/v1/events/inventory to find events recording the progress of the deletion. For example, to find the status of a previously submitted delete request less than 10 minutes ago:

/ws/v1/events/inventory?query=context_id=‘xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx’&start_time=-10m.

n Added the GET /ws/v1 to get a list of available web services.

n Added ability to perform bulk import/update devices with a csv file and provided an example

CSV file to download.

n Corresponding data streams page is linked from the data streams tab in device details.

n Added priority text and icon to the slide-in notifications menu.

n Added an id field to the ws/v1/events/inventory web service to uniquely identify an event log

entry.

n Provide more details in the RCI request error message when the problem is related to device

descriptors.

n Improved message returned when a user tries to register more devices than the license limit

for the account.

Digi Remote Manager 3.0 Help

Welcome What's new in February 2021

Resolved issues

n Fixed an issue with displaying more than 100 users within the user list.

n Fixed an issue where some configuration settings were not being applied to DigiIX/TX devices

when the settings were not exposed by the conditional/dependsVal setting. The hidden settings are not managed by the config anymore, so the system will not try to apply them to a device (if they are not visible in the UI).

n Fixed lack of error message for decimal input in integer fields.

n Fixed a bug that caused the csv export of the data streams table to fail when sorting by

Stream ID. Fixed a bug that prevented the data streams table from being sorted properly.

n Fixed a problem with Add Group validation.

n Fixed a problem with the next_uri field for the paging related /ws/v1/notifications/* web

services. The next_uri field would sometimes have two cursor values in it and would not correctly URL-encode the output cursor values.

n Fixed a problem with the 'Firmware Status' column in the device list. Devices running the latest

firmware may have shown a firmware status of ‘Non Production’. Now they will show ‘Up to Date’ as intended.

n Fixed a problem that caused a query_state request to fail when a device listed a cellular sim

with an invalid phone number of a certain format.

For previous release notes, see Previous release notes.

Digi Remote Manager 3.0 Help

About Digi Remote Manager

Digi Remote Manager is a cloud-based device management and data enablement platform that makes it easy to connect your application to the data on which your business relies. With Digi Remote Manager, you can efficiently interact with any device or device data in your Remote Manager inventory. You can:

n Ensure your devices are up to date by automatically applying security patches, firmware, and

configurations.

n Monitor the state of all of your devices to quickly identify, assess, and respond to issues.

n Set up custom alerts to inform you that an issue requires your attention.

n Automate remediation for devices out of compliance.

n Deploy application logic to any devices, such as routers and gateways.

Quick start

When you log into Digi Remote Manager 3, the dashboard appears.

Screen item Desciption

Show/hide menu

User menu User account options.

Tools Tools available for the current option.

Display area

Menus and icons

Digi Remote Manager uses the following icons throughout the interface.

Digi Remote Manager 3.0 Help

Toggle to show/hide the main menu.

Digi Remote Manager options.

Display area for the current option.

Menus

Icon Description

Activity

Alerts

Dashboard

Menus and icons

Icons

Icon Description









Add

Advanced search on/off toggle

Barchart

Column selector

Devices

Users



Digi Remote Manager 3.0 Help

Configuration

Icon Description

Menus and icons





/















Success

 Pending

 Failed



Connection status

 Connected

 Disconnected

Copy to clipboard

Dark mode/Light mode

Delete/cancel

Disconnected

Download

Edit

Groups

Health status

Home

Job status

List view

























Lock

Maintenance mode

Map view

Connected devices

Disconnected devices

Never connected devices

More actions (Select Columns, Export as CSV, and so on)

Refresh

Save

Table view

Trash

Unlock

Upload

Digi Remote Manager 3.0 Help

Icon Description

Search and filters for lists





User

Users

Search and filters for lists

Many Digi Remote Manager pages display lists—device lists, user lists, alerts lists, and so on. There are two modes for filtering lists: simple and advanced.

You toggle between simple and advanced using the following button:

Simple search

When you use the simple search, you can enter any text free-form. Remote Manager searches all columns using your search string. If you toggle to advanced search, Remote Manager converts the simple search to an advanced filter. For example, if you searched for "mydevice" and then toggle to advanced search, Remote Manager displays the followings:

You can then edit the filter as needed. See Advanced filter.

Advanced filter

You can filter lists using relevant attributes, and you can build complex filters by combining multiple filters.

Note Filters apply to all list columns, both displayed and hidden.

Toggle to advanced search:

Filter lists using attributes and comparison operators

Each Digi Remote Manager list page offers a set of attributes associated with the list items. For example, device attributes include name, description, notes, and so on. User attributes include user name, role, policies, and so on.

Digi Remote Manager 3.0 Help

Search and filters for lists

Once you select an attribute to use as a filter, add a comparison operator and a value.

Use any of the following comparison operators:

Operator Description

= Equal to

Note This is the default comparison operator. That is, if you don't specify a comparison,

Remote Manager uses =.

> Greater than

< Less than

>= Greater than or equal to

<= Less than or equal to

<> Not equal to

Note Values are not case sensitive. For example, Warning, WARNING, and warning are equivalent.

For example, to create a filter that returns all devices with a Health Status equal to warning:

1. Click in the filter bar and select Health Status.

2. Type warning.

3. Press Enter.

Build a complex filter using logical operators AND/OR

You can combine multiple filters together to build one complex filter. For example, to view all devices with a Health Status of warning and a Connection Status of connected:

Digi Remote Manager 3.0 Help

Toggle between AND and OR

By default, each additional filter you enter is joined to the existing filter by the AND operator. Toggle between AND and OR by clicking on AND or OR within the filter.

Edit or delete a filter

n To edit a filter, click . n To delete a filter, click . Or use BACKSPACE to remove one or more filters.

Export data as CSV

You can export all the data in a view to a CSV file. The export includes all objects in the current view.

If you filter a view, the export includes only the objects included in the filtered view.

To export data to a CSV file

1. Click Devices, Activity, or Users.

2. If you want to filter the display before exporting, use either a simple search or advanced filter

to display a set of objects.

3. Click and select Export as CSV.

Export data as CSV

Copy device ID to clipboard

When a device ID is displayed in table data, you can copy the device ID to the clipboard.

To copy the device ID to the clipboard

1. Click Devices.

2. Click . The full device ID is copied to your clipboard.

Select table spacing

You can select the amount of space (leading) used to display table data: Compact, Comfy, or Roomy. The default is Comfy.

The table spacing you select is used as the default table spacing for all Remote Manager displays.

To select table spacing

Digi Remote Manager 3.0 Help

1. Click Devices, Activity, or Users.

2. Click  and select Table Preferences > Table Spacing.

3. Select the amount of spacing to use: Compact, Comfy, or Roomy.

Select how to display device ID

You can select to display the full device ID or a shortened (friendly) device ID in table displays.

Note Regardless of the device ID display (friendly or full), the Copy device id copies the full device ID

to the clipboard.

To select how device IDs are displayed in tables

1. Click Devices.

2. Click  and select Table Preferences > Device ID.

3. Select Friendly or Full.

User menu options

The upper-right corner of the display includes the User menu:

Select how to display device ID

From the User menu, you can:

n Get help

n Open Classic Remote Manager

n Provide Feedback for the Remote Manager service

n Display the What's New dialog

n Toggle dark mode on or off

n Change your password

n Edit your user profile

n Logout

Digi Remote Manager 3.0 Help

Subaccounts menu

Note Only users assigned an administrator role can view and manage subaccounts. At this time, the

new Remote Manager allows administrators the ability to scope using subaccounts. To create and manage subaccounts, return to classic Remote Manager. See About subaccounts for more information.

The upper-right corner of the display includes the Subaccounts menu:

Subaccounts menu

From the Subaccount menu, you can set the subaccount for your Remote Manager session.

When you set the subaccount, Remote Manager displays devices and processes for that subaccount only.

Digi Remote Manager 3.0 Help

Dashboard

The Dashboard shows device health and status information charts:

Connection status

Health status

Alerts

Signal strength

IPsec status (1-4)

Inventory status

Each chart is a widget you can include or exclude, position, and size on your dashboard. See Customize

your dashboard.

Connection status

Connection status shows a summary of the number of devices connected, disconnected, or never connected. Never connected denotes a registered device that has not yet connected to Remote Manager.

To filter data included in the chart

n Click a status label beneath the chart to include or exclude that status. For example, to exclude

the devices with a status of Never connected, click the Unknown label:

Digi Remote Manager 3.0 Help

+ 41 hidden pages