set mgmtnetwork

Purpose

A Remote Manager server allows devices to be configured and managed from remote locations. set mgmtnetwork configures the network settings for the Digi device’s connection to the Remote Manager server so the device knows how to connect to the server.

Required permissions

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

Syntax

Configure Remote Manager network settings

set mgmtnetwork
[networktype={modemppp|ethernet|802.11}] [connectionmethod={auto|none|mt|mtssl|mdh|proxy}] [proxyaddress= address text]
[proxyport=port]
[proxylogin=login text]
[proxypassword=password text]
[proxypersistentconnection={on|off}]
[mtrxkeepalive=time in seconds]
[mttxkeepalive=time in seconds]
[mtwaitcount=wait count]
[mdhrxkeepalive=time in seconds]
[mdhtxkeepalive=time in seconds]
[mdhwaitcount=wait count]
[sslvalidatepeer={on|off}]

Note networktype=modemppp is used for mobile networks (WiMAX and cellular).

Note For Remote Manager service, connectmethod must be set to mt or mtssl, since the other connection methods are not supported by Remote Manager.

Display Remote Manager network settings

set mgmtnetwork

Options

About keep-alive and wait-count settings on this command

The set mgmtnetwork rxkeepalive settings specify how frequently the device sends a keep-alive packet to the server if the Remote Manager connection is idle. The server expects to receive either data messages or keep-alive packets from the device at this interval.

The txkeepalive settings specify how frequently the server sends a keep-alive packet to the device if the Remote Manager connection is idle. The device expects to receive either data messages or keep-alive packets from the server at this interval.

After the number of consecutive expected keep-alives specified on the waitcount option are missed according to the configured intervals, the connection is considered lost and is closed by the device and server.

networktype={modemppp|ethernet|802.11}

The type of network to which this command applies.

modemppp

A modem PPP network.

Note networktype=modemppp and any settings associated with it apply to both cellular and WiMAX networks used by the Digi device.

ethernet

An Ethernet network.

802.11

An 802.11 network.

connectionmethod={auto|none|mt|mdh|proxy}

The firewall traversal method used by the protocol used to manage and pass data between devices and Remote Manager, known as EDP.

auto

Automatically detect the connection method.

none

No firewall; connect using TCP.

mt

Connect using TCP.

mtssl

Connect using an SSL connection to the Remote Manager server. This method offers for improved security of the connection and is the default connection method in current Digi device firmware.

mdh

Connect using HTTP.

proxy

Connect using HTTP over proxy.

proxyaddress=address text

The proxy host address when the connection method is proxy.

proxyport=port

The proxy host port when the connection method is proxy.

proxylogin=login text

The login string when the connection method is proxy.

proxypassword=password text

The proxy password when the connection method is proxy.

proxypersistentconnection={on|off}

 

Whether the device server should attempt to use HTTP persistent connections when the connection method is proxy. Not all HTTP proxies correctly handle HTTP persistent connections. The use of persistent connections can improve performance of the exchange of messages between the device server and the Remote Manager server, when that connection is HTTP/proxy. The reason for this is that the same HTTP connection can be reused for multiple consecutive HTTP requests and replies, eliminating the overhead of establishing a new TCP connection for each individual HTTP request/reply, then closing that connection when the request is complete.

on

The device server should attempt to use HTTP persistent connections.

off

The device server should not attempt to use HTTP persistent connections.

mtrxkeepalive=time

The transmit keep alive time when connection method is mt or mtssl, where time is the number of seconds to wait between sending keep-alive messages.

mttxkeepalive=time

When the connection method is mt or mtssl, the receive keep alive time, where time is the number of seconds to wait for a keep-alive message from the Remote Manager server before assuming the connection is lost.

mtwaitcount=count

When the connection method is mt or mtssl, used to specify the wait count where count is how many timeouts occur before the Digi device assumes the connection to the Remote Manager server is lost and drops the connection.

mdhrxkeepalive=time

When the connection method is mdh, used to specify the transmit keep alive timlocal_address={IP where time is the number of seconds to wait between sending keep-alive messages.

Important: It is recommended that this interval value be set as long as your application can tolerate to reduce the amount of data traffic.

mdhtxkeepalive=time

When the connection method is mdh, used to specify the receive keep alive time, where time is the number of seconds to wait for a keep-alive message from the Remote Manager server before assuming the connection is lost.

mdhwaitcount=count

When the connection method is mdh, used to specify the wait count, where count is how many timeouts occur before the Digi device assumes the connection to the Remote Manager server is lost and drops the connection.

sslvalidatepeer={on|off}

If connectmethod=mtssl, selects whether the server's certificate is required to be validated before the Digi device’s connection to the Remote Manager server is made.

on

The Remote Manager connection will only be allowed if the server certificate is validated. If it cannot be validated, the connection is not made. The recommended method of validating the server's certificate is by y installing a CA certificate for the signer or the server's certificate. Having the server's certificate installed as a “trusted peer” certificate is not recommended.

off

The Remote Manager connection is allowed without validating the server certificate.

Examples

Set instance 1 for proxy connection

#> set mgmtnetwork connectiontype=modemppp connectionmethod=proxy 
proxyaddress=”What goes here?” proxyport=40002 proxylogin=”johnsmith” 
proxypassword=”testpass” proxypersistentconnection=off

Set instance 2 for mdh connection

#> set mgmtnetwork connectiontype=ethernet connectionmethod=mdh 
mdhrxkeepalive=100 mdhtxkeepalive=110 mdkwaitcount=15

Display current Remote Manager network settings

#> set mgmtnetwork

See also