set mgmtconnection

Purpose

Configures or displays Remote Manager server connection settings. A Remote Manager server allows devices to be configured and managed from remote locations. These connection settings set up the connection to the Remote Manager server so, the Digi device knows how to connect to the server.

You can choose how your Digi device connects to and communicates with the Remote Manager server, through a device-initiated connection, a server-initiated connection, or a (device-initiated) timed connection, including paged connections. If Short Message Service (SMS) capabilities are enabled on how your Digi device, a paged connection is another means by which a device-initiated connection may be requested.

In a device-initiated connection, the Digi device attempts to reach the Remote Manager server to establish the connection. An advantage of the device-initiated connection is that it can be used on any network, whether the device has a public or private IP address, as long as the Remote Manager server is accessible on that network.

A server-initiated connection works the opposite way. The Remote Manager server opens a TCP connection and the Digi device listens for the connection. An advantage of a server-initiated connection is that the connection is only established when it is needed - this minimizes the overhead of maintaining a connection. A disadvantage is that Remote Manager server's device list will display the device as disconnected most of the time. In addition, server-initiated connections cannot be used if the device has a private IP address or is behind a NAT.

A timed connection is another form of a device-initiated connection. For a timed connection, the Digi device attempts to connect to the Remote Manager server at a configured, regular interval (period). If a connection to a Remote Manager server is already established, the timed connection will not be attempted. The next attempt for a timed connection will occur at the next scheduled interval.

A paged connection is another form of a device-initiated connection. This type of connection is initiated by an on-demand request, such as a Short Message (SM) received via a cellular modem (from a mobile service provider). The request message may specify the Remote Manager server with which the device should connect, or it may simply request that the device connect to the Remote Manager server that is configured in the Paged Remote Manager Connection settings.

Required permissions

For Digi products with two or more users, to use this command, permissions must be set to set permissions s-mgmtconnection=read to display Remote Manager connection settings, and set permissions s‑mgmtconnection=rw to display and set DRemote Manager connection settings. See set permissions for details on setting user permissions for commands.

Syntax

Configure Remote Manager server connection settings

set mgmtconnection [svraddr[1-4]=string] 
  [secidx[1-4]=index]
  [conntype={client|timed|serverinitiated|paged}] 
  [connenabled={on|off}] 
  [timedperiod=1-65535] 
  [timedoffset={immediate|oneperiod|randomtime}] [lkaupdateenabled={on|off}] 
  [clntreconntimeout={none|timeout]
  [pagedoverrideenabled={on|off}]

Display Remote Manager server connection settings

set mgmtconnection

Options

svraddr[1-4]=string

Server address text. Used to specify one of eight possible Remote Manager server addresses. When the device server attempts to connect to the Remote Manager server, it tries the server addresses in this list in the order 1-4.

secidx[1-4]=index

Index into security settings. Used to link a server address with a Device Security entry.

conntype={client|timed|serverinitiated|paged}

Used to specify the connection type.

client

This is a client connection.

timed

This is a timed connection.

serverinitiated

This is a server-initiated connection.

paged

This is a paged connection. A paged connection is support for receiving a short message (SMS) that can request that the device connect to a Remote Manager server. The connection to Remote Manager is initiated by the client. A paged connection is a temporary, as-needed Remote Manager connection that is created based on a user action, for example, by calling a Python function, or sending a request-connect SMS command.

When enabled and a request is received to do so, the Digi device will initiate the connection to the Remote Manager server. A paged connection is initiated on demand when a request to connect is received from an external communication, such as a Short Message received via a mobile service provider. The external communication may specify the Remote Manager server with which the device should connect, or it may simply request that the device connect to the Remote Manager server that is configured in the Paged Remote Manager Connection settings.

Paged Remote Manager Connections provide emergency access to your Digi device, directing it to connect to the Remote Manager server so management or application operations may be performed.

A Paged Remote Manager Connection can be configured to disconnect an established connection to a Remote Manager server so the paged connection can be established instead, or it may configured to defer to a connection that is already established.

If paged Remote Manager connections are not enabled by this setting and the connenabled setting, paged connection requests will be refused if received via external communication. This setting and the connenabled setting controls whether or not paged Remote Manager connections will be permitted.

connenabled={on|off}

Whether this connection instance is enabled for use.

on

Enables this connection instance for use.

off

Disables this connection instance for use.

timedperiod=1-65535

For a timed connection, the time interval in minutes between the device server's attempts to connect to the Remote Manager server. If a device server is already in a connection to a Remote Manager server when the time interval expires, it will not start a new connection at that time. Rather, the device server will start a new timed period timer, and it will again check whether it needs to connect to the Remote Manager server when that new timer expires. The default is 5.

timedoffset={immediate|oneperiod|randomtime}

For a timed connection, when the first timed connection to a Remote Manager server should be attempted after the Digi device boots.

immediate

Attempt to connect immediately.

oneperiod

Wait one full timed period, then attempt to connect.

randomtime

Wait some random interval of time, between 0 and the full timed period, then attempt to connect.

lkaupdateenabled={on|off}

In conjunction with a server-initiated connection, this option enables or disables a connection to a Remote Manager server to inform that server of the IP address of the device server. This permits the Connectware Manager to connect back to the device server, or to dynamically update a DNS with the IP address of the device.

on

Enables “last known address” connections to the Remote Manager server.

off

Disables “last known address” connections to the Remote Manager server.

clntreconntimeout={none|timeout}

Specifies the retry timeout interval, in seconds, for a last-known-address (LKA) update, if the LKA update fails. If an LKA update fails, the interval configured by this option is used as the amount of time to wait before attempting another LKA update. This option is used for both client-initiated and server-initiated connections. The keyword none turns off the retry timeout interval feature.

pagedoverrideenabled={on|off}

Controls how the Digi device handles user requests for a paged connection.

on

If a user requests a paged connection and a Remote Manager connection already exists, the current connection is dropped and a new connection is created.

off

The paged connection request is ignored.

The most common scenario is that paged and client-initiated connections use the same server URL, so if the Digi device is connected via any connection, it is connected, and this option should be off. Otherwise, the Digi device will unnecessarily drop its connection and reconnect if this option is on.

Examples

Set values for the client connection

#> set mgmtconnection connenabled=on conntype=client clntreconnecttimeout=50

Display current connection settings

#> set mgmtconnection