set mgmtglobal

Purpose

A Remote Manager server allows devices to be configured and managed from remote locations. This command is used to set or display the Remote Manager global settings, or revert the device ID to factory settings.

Required permissions

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

Syntax

Configure Remote Manager global settings

set mgmtglobal [deviceid={hex string}]
  [revertdeviceid]
  [rcicompressionenabled={on|off}]
  [tcpnodelayenabled={on|off}]
  [tcpkeepalivesenabled={on|off}]
  [connidletimeout={none|timeout value}]
  [dataserviceenabled={on|off}]           (default=on}
  [dataserviceurl=valid url (path only)]  (default=/ws/device)
  [dataserviceport=0-65535]               (default=800
  [dataservicesecureport=0 - 65535]       (default=443)

Display Remote Manager global settings

set mgmtglobal

Revert the Device ID to factory settings

set mgmtglobal revertdeviceid

Options

deviceid={hex string}

Used to specify the device ID. The device ID is 32 hexadecimal digits, preceded by the characters 0x.

rcicompressionenabled={on|off}

Configures whether RCI command and response text is compressed, when both are passed between the Digi device and the Remote Manager server. This compression primarily affects the size of the data passed when settings or state information are formatted as RCI and conveyed between device and server. Using compression on this RCI text can reduce the size of passed data, and, for cellular products, reduce the cost of reading and writing device settings.

When RCI compression is enabled, LIBZ compression is used on RCI command and response text when it is sent between device and server. The protocol used to manage and pass data between devices and Remote Manager, known as EDP, internally negotiates whether compression is applied. RCI compression is enabled, or on by default to reduce byte count and cost of sending data. As an example of savings, typical cellular router settings will compress to about 8% of its original size, which means that data can be sent in far fewer packets and less time, than when the uncompressed version of the same data is sent.

The default is on. The ability to turn off RCI compression is provided for technical support/troubleshooting purposes; for example, if you want to eliminate the possibility that this compression is causing a problem.

tcpnodelayenabled={on|off}

Configures whether use of the TCP NODELAY option is disabled by default for the Remote Manager connection between device and server, when configuring the device's TCP socket endpoint for that connection.

The ability to turn on the TCP NODELAY option is provided for technical support/troubleshooting purposes.The default is off. This default reduces the number of packets sent when the Remote Manager connection is established between device and server. While there is a very slight penalty in terms of added latency, that penalty is very small compared to the relative high latencies for cellular network communications. Reducing the packet count reduces the number of bytes exchanged over the cellular connection, which saves money. The typical start-up data count is reduced from about 7KB to 4KB just by disabling TCP NODELAY.

tcpkeepalivesenabled={on|off}

Enables or disables sending of TCP keep-alive packets over the client-initiated connection to the Remote Manager server, and whether the device waits before dropping the connection. The default is on.

TCP keep-alives are performed at the TCP protocol level. The application (in this case, the Remote Manager server) that is using that connection does not know anything about when the TCP keep-alives are sent or received. The TCP keep-alives simply serve to keep each end of the TCP connection aware that the connection is still viable, and intermediate network equipment (NATs in particular) is also made aware that the connection is still good.

connidletimeout={none|timeout value}

Enables or disables the idle timeout for the Remote Manager connection between device and server. Specifying none disables the idle timeout. Specifying a timeout value enables the idle timeout, which means the connection will be dropped, or ended, after the amount of time specified. The default is on. The minimum value is 300 and the maximum 43200.

In contrast to TCP keep-alives, the timeout managed by the connidletimeout option is at the Remote Manager application level. The connidletimeout option provides a way for the connection to the Remote Manager server to be closed if no Remote Manager protocol data is sent or received for some period of time. This capability is particularly useful for server-initiated connections. When a user at the server side requests that a connection be established to a device, that user needs to explicitly terminate the connection when they are done with the device. This timeout permits a way to configure the device such that a “forgetful user” does not inadvertently leave the connection in place, which could cost money on a cellular connection if Connectware or TCP keepalives are enabled and transferred needlessly between device and server.

revertdeviceid

Reverts the device ID to factory settings. For example, if the device’s MAC address is GG:HH:JJ:KK:LL:MM, the device ID is set to 0x0000000000000000GGHHJJffffKKLLMM.

Examples

Set the device id

#> set mgmtglobal deviceid=0x0123456789abcdef0123456789abcdef