Command Reference Digi Connect® Family Digi Connect Family: Digi Connect SP, Digi Connect Wi-SP, Digi Connect ME, Connect ME4, Digi Connect Wi-ME, Digi Connect EM, Digi Connect Wi-EM, Digi Connect ES Family (Digi Connect ES 4/8/16 devices) ConnectPort• TS Products: ConnectPort TS 8, ConnectPort TS 8 MEI Digi Cellular Family: Digi Connect WAN, Digi Connect WAN VPN, Digi Connect WAN Sync, Digi Connect WAN IA, ConnectPortTM WAN VPN Connect WAN Family: Digi Connect• WAN, Digi Connect WAN VPN, Digi Connect WAN
© Digi International Inc.2007. All Rights Reserved.
Contents Chapter 1 Introduction Digi Connect Products and Families to Which This Book Applies.........7 Quick Reference for Configuring Features ............................................8 Access the Command Line.................................................................. 11 Configure an IP Address .....................................................................11 Basic Command Information ...............................................................
set ethernet........................................................................................107 set forwarding .................................................................................... 109 set gpio .............................................................................................. 113 set group............................................................................................ 115 set host .................................................................................
who .................................................................................................... 258 Chapter 3 Modem Emulation Commands What Is Modem Emulation? .............................................................. 259 Modem Emulation Cable Signals ...................................................... 259 Modes of Operation ........................................................................... 259 Common User Scenarios for Modem Emulation ...............................
Contents
Digi Connect Products and Families to Which This Book Applies Introduction Chapter 1 This book describes the commands in the command-line interface for several Digi product families, listed below. This chapter provides the following: • A quick reference showing the commands used to configure features or perform configuration tasks from the command line.
Quick Reference for Configuring Features Quick Reference for Configuring Features The following table shows common features that can be configured from the command line, and the commands used to configure each feature. If you are viewing the PDF file of this document, click the commands in the “Commands” column to go to the command descriptions. Feature/Task Alarms "set alarm" on page 70. Autoconnection (automatically connect a user to a server or network device) "set autoconnect" on page 81.
Quick Reference for Configuring Features Feature/Task Commands IP Forwarding and Network Address Translation (NAT) "set forwarding" on page 109. "set nat" on page 146.
Quick Reference for Configuring Features Feature/Task Commands Serial port configuration Serial port communication options: "set serial" on page 189. Port profiles: "set profile" on page 172. RCI serial mode: "set rciserial" on page 184. RTS Toggle: "set rtstoggle" on page 187. TCP serial connections: "set tcpserial" on page 212. UDP serial characteristics: "set udpserial" on page 216.
Access the Command Line Feature/Task Wireless devices Commands "set wlan" on page 241. "set ekahau" on page 104. Access the Command Line To configure devices using commands, you must first access the command line, and then log on as needed. This procedure assumes that you have already configured the Digi device with an IP address. 1.
Basic Command Information Basic Command Information Navigation and Editing Keys Use the keys listed in the table to navigate the command line and edit commands: Action Keys Move the cursor back one space. Ctrl+b Move the cursor forward one space. Ctrl+f Delete the character to the left of the cursor. Back space or Ctrl+h Delete the character under the cursor. Delete Scroll back through commands. Ctrl+p Scroll forward through commands. Ctrl+n Execute the command.
Basic Command Information Entering Special Characters in String Values Several commands have options that are string values, for example the “set alarm” command’s “match” option and the “set autoconnect” command’s “connect_on_string” option. Escape Sequences for Special Characters Special characters can be entered in strings using the following escape sequences: Escape Sequence Processed as: \* Match any character. This escape sequence is only available on the “set alarm match=string” option.
User Models and User Permissions in Digi Connect Products User Models and User Permissions in Digi Connect Products The user model in a Digi Connect product influences the commands that users can issue. There are three user models implemented in the various Digi Connect and ConnectPort devices: one-user model, two-user model, and more than two-user model.
User Models and User Permissions in Digi Connect Products Login Suppression Feature The login prompt can be disabled by issuing the “set login” command. See "set login" on page 131. Increasing Security for Digi Device Users As needed, you can enforce additional security for device users. For example, you can use the autoconnect feature, where a user is automatically connected to another system without accessing the Digi device’s command line. See "set autoconnect" on page 81.
User Models and User Permissions in Digi Connect Products 16 Chapter 1 Introduction
Verifying Device Support for Commands Command Descriptions Chapter 2 This chapter provides a description of each command in the Digi Connect Family Command-Line Interface. Verifying Device Support for Commands To verify whether a Digi Connect device supports a particular command or command options, and to get the allowed ranges and limits for command options, you can enter several commands. For example: • “help” displays all supported commands for a device.
backup backup Devices supported This command is supported in all Digi Connect products. Purpose Save the device configuration to a TFTP server located on the network, or restores the configuration from a saved copy on the TFTP server. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions backup=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
boot boot Devices supported This command is supported in all Digi Connect products. Purpose Reboots the device server, restores the device configuration to factory default settings, or loads new firmware files (both EOS and POST images) from a TFTP server. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions boot=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
boot Examples Restore configuration defaults This example reloads the firmware stored in flash ROM and resets the configuration to factory defaults then reboots the device. #> boot action=factory Reboot using the current firmware and configuration This example reboots the device and uses the current firmware and configuration stored in flash ROM. #> boot action=reset Reboot using firmware from a boot host This example loads the firmware stored on the TFTP host into flash ROM.
close close Devices supported This command is supported in all Digi Connect products. Purpose Closes active connect, Rlogin, and Telnet sessions; that is, sessions opened by “connect,” “rlogin,” or “telnet” commands. The “close” command is associated with the sessions displayed by the “status” command. A “close” command issued without any options closes the current connection. To issue the “close” command, you must escape the active session.
connect connect Devices supported This command is supported in all Digi Connect products. Purpose Used to make a connection, or establish a session, with a serial port. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions connect=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
dhcpserver dhcpserver Devices supported This command is supported in Digi Cellular Family products only. Purpose Used for managing and showing the status of a DHCP server, including managing the leases for IP addresses, restarting, running, and shutting down the DHCP server, and displaying DHCP server status information. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions connect=execute” to use this command.
dhcpserver Example Display DHCP server status #> dhcpserver status Device Networking Status: IP address : 10.30.1.188 Subnet mask : 255.255.255.0 Default gateway : 10.6.6.6 Static IP configured : yes Uptime : 0 days + 21:00:44 DHCP server status: running Uptime : 0 days + 21:00:36 Scopes configured in server: Scope 1: Name : eth0 IP address : 10.30.1.188 Subnet mask : 255.255.255.0 Starting IP address : 10.30.1.190 Ending IP address : 10.30.1.198 Routers : 10.30.1.
dhcpserver IP address : 10.30.1.197 Client ID : 00:09:26:19:51:07 Lease duration : using scope lease duration Address exclusions: none configured Lease Records: Client ID IP Address (MAC Address) Lease Time in Seconds Duration Remaining Lease Record Status --------------- ----------------- ---------- ---------- -----------------10.30.1.135 00:40:9D:24:73:F8 3600 1834 Reserved (active) 10.30.1.192 02:40:9D:24:73:F8 3600 N/A Reserved (inactive) 10.30.1.
dhcpserver DHCP server will mark the address as unavailable. The lease will remain in this state for 4 hours, after which it is reverts to the Reserved (inactive) status. Offered (pre-lease) A lease has been offered to the given client, but that client has not yet requested that the lease be acknowledged. It may be that the client also received an offer from another DHCP server, in which case this offer will expire in approximately 2 minutes.
display display Devices supported This command is supported in all Digi Connect products. Purpose Displays status information for a Digi Connect device. The “display” command’s focus is on real-time information. In contrast, the “info” command displays statistical information about a device over time, while the “status” command displays the status of outgoing connections (connections made by “connect,” “rlogin,” or “telnet” commands).
display • • Virtual Private Network (VPN) information, including Security Association (SA) database entries and Security Policy Database (SPD) entries. Typical wireless LAN (WLAN) parameters for wireless devices. 100% CPU Utilization may indicate encryption key generation is in-progress There may be instances when a “display device” command returns a CPU utilization of 100%. A CPU usage this high may indicate that encryption key generation is in-progress.
display device Displays general product information including product name, MAC address, boot, post, and firmware versions, memory usage, CPU utilization, and uptime. The information displayed by this option is the same as that displayed by the “info device” command (see "info" on page 41). ddns Displays status information for the Dynamic DNS (DDNS) service. See "set ddns" on page 92 for information on the DDNS service. gpio Displays GPIO signals.
display serial Displays serial modem signals (DTR, RTS, CTS, DSR, DCD). sockets Displays information about how socket resources are being used by the system. spd Displays Security Policy Database (SPD) entries defined for Virtual Private Network (VPN) tunnels. switches Displays Multiple Electrical Interface (MEI) switch settings currently currently defined for ports, on devices supporting MEI. (See "set switches" on page 208.) tcp Displays active TCP sessions and active TCP listeners.
display Example Display device information #> display device Device Information: Product : Digi Connect ME MAC Address : 00:40:9D:24:8B:B3 Firmware Version : 1.9.0 (Version 82000856_F5 09/16/2005) Boot Version : 0.0.0.1 (release_82000866_C) Post Version : 0.0.0.
display Output This section describe and interprets selected information and statistics output by the “display” command. Information returned by “display pppstats” The “display pppstats” displays status and activity information for a PPP link, and SureLink statistics. This information is specific to Digi Cellular Family products. PPP status and activity information In these status and activity values, a “session” is a PPP session. The session statistics are reset to zero at the start of a new PPP link.
display reset status These PPP status values describe why a PPP link was terminated. idle resets The number of resets because the idle timeout was reached/exceeded for transmitted and received data. These idle timeouts are set by the “set pppoutbound” command. Most of the time, no idle timeout is used on transmitted data. no carrier resets The number resets because the carrier was dropped for any reason. no service resets The number of resets because the data network was not available.
display last reset reason The reason for the most recent reset of the PPP link. idle An idle reset brought down the link last. lcp keepalive An LCP keepalive reset brought down the link last. surelink Surelink tests failed and brought down the link. no service The modem received a “no service” indication on the monitoring channel, and brought down the link. no carrier The modem dropped the link (hard), and was responsible for the termination of the last link.
display lcp echo requests The number of Link Control Protocol (LCP) echo requests that have been sent after a “quiet” interval, in order to test the PPP link and/or keep it alive. For Digi Cellular products, LCP echo requests are typically not used. SureLink Statistics Digi SureLink™ provides an “always-on” mobile network connection to ensure that a Digi Cellular Family device is in a state where it can connect to the network.
display total link down requests The number of times the SureLink feature has failed consecutively the configured number of failures and, as a result, requested that PPP shut down and restart its connection. This statistic counts such occurrences during the current device boot. SureLink itself does do the PPP stop/start; it sends a message to PPP asking it to do so, owing to a Surelink test failure. total bypasses The total test bypasses (see “session bypasses”) since the Digi device was rebooted.
display buffers display buffers Devices supported This command is supported in all Digi Connect products except Digi Connect WAN and ConnectPort Display. Purpose Displays the contents of a port buffer, or transfers the contents of a port buffer to a server running Trivial File Transfer Protocol (TFTP). Port buffering is enabled by the “set buffer” command (see "set buffer" on page 90). Contents are displayed in log form.
display buffers Examples Display port buffering information on the screen #> display buffers port=2 screen lines=32 tail=30 Output buffering information to a TFTP server #> display buffers port=2 tftp=192.168.1.1:port_ouput Output multi-port buffering information to a TFTP server #> display buffers port=2-3 tftp=192.168.1.1:port_ouput Note that port 2 buffering information goes to file port_output_2 and port 3 buffering information goes to file port_output_3. See also 38 • "set buffer" on page 90.
exit exit Devices supported This command is supported in all Digi Connect products. Purpose Terminates your current session. Syntax exit Example #> exit See also "quit" on page 59. The “quit” and “exit” commands perform the same operation.
help and ? help and ? Devices supported This command is supported in all Digi Connect products. Purpose Displays help about a specific command. Syntax help [command] OR [command]? Examples #> help boot #> boot? #> help set serial #> set serial? See also 40 "Displaying Online Help" on page 12.
info info Devices supported This command is supported in all Digi Connect products. Purpose Displays statistical information about a device. The “info” command displays statistical information about a device over time. In contrast, the “display” command’s focus is on real-time information, while the “status” command displays the status of outgoing connections (connections made by “connect,” “rlogin,” or “telnet” commands).
info serial Displays statistics from the serial table. For descriptions of these statistics, see "Output" on page 42. tcp Displays statistics from the TCP table. udp Displays statistics from the UDP table. wlan Displays statistics from the wireless Ethernet (wlan) table. Output Following are descriptions of the statistics displayed for each “info” command option. The statistics displayed include data, event, and error counts.
info Ethernet statistics Statistic Description InBytes Number of bytes received. OutBytes Number of bytes sent. InUcastPkts Number of Unicast packets received. OutUcastPkts Number of Unicast packets sent. InNonUcastPkts Number of non-Unicast packets received. OutNonUcastPkts Number of non-Unicast packets sent. InDiscards Number of incoming packets that were discarded. OutDiscards Number of outgoing packets that were discarded. InErrors Number of incoming packets that contained errors.
info IP statistics Statistic 44 Description InReceives Number of datagrams received. OutRequests Number of datagrams given to IP to transmit. InAddressErrors Number of received datagrams discarded because they were for another host and could not be forwarded. DatagramsForwarded Number of received datagrams forwarded to another host. InHeaderErrors Number of received datagrams discarded because of invalid header information.
info Serial statistics Statistic Chapter 2 Description rbytes Total data in: the number of bytes received. tbytes Total data out: the number of bytes transmitted. overrun errors The number of times FIFO has overrun. The next data character arrived before the hardware could move the previous character. overflow errors The number of times the Received buffer has overrun. The receive buffer was full when additional data was received. frame errors The number of framing errors detected.
info TCP statistics Statistic Description InSegments Number of segments received. OutSegments Number of segments sent. InErrors Number of segments received with errors. RetransmitSegments Number of segments retransmitted. Segments are retransmitted when the server doesn't respond to a packet sent by the client. This is to handle packets that might get lost or discarded somewhere in the network. EstabResets Number of established connections that have been reset.
info Wireless (WLAN) statistics The WLAN statistics may aid in troubleshooting network communication problems with your wireless network. For additional wireless settings and an evaluation of the wireless settings, issue a "show wlan" command. See "show" on page 249. Statistic Chapter 2 Description TxFrames Number of frames transmitted. TxBroadcastFrames Number of broadcast frames transmitted. TxRtsFrames Number of Request-to-Send (RTS) frames transmitted.
info Examples Display ICMP statistics #> info icmp ICMP statistics: See also InMessages : 14 OutMessages : 0 InDestUnreachables : 5 OutDestUnreachables : 0 InErrors : 0 • • • 48 "display" on page 27. "show" on page 249. The "show wlan" command displays settings and evaluation information that may be useful to view in addition to the wireless statistics displayed by this command.
kill kill Devices supported This command is supported in all Digi Connect products. Purpose Use the kill command to kill connections. The kill command is associated with the connections displayed by the “who” command. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions kill=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
mode mode Devices supported This command is supported in Digi Connect Family products only and not in Digi Cellular Family products or ConnectPort Display. Purpose Changes or displays the operating options for a current Telnet session. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions telnet=execute” to display or set Telnet operating options. See "set permissions" on page 157 for details on setting user permissions for commands.
newpass newpass Devices supported This command is supported in all Digi Connect products. Purpose Creates or changes user passwords for the device. In Digi devices with a single-user model, changing the “root” user password also changes the password for Advanced Digi Discovery Protocol (ADDP). In Digi devices with the multi-user model, changing the “root” password has no effect on ADDP. To change the ADDP password, you would specify “name=addp.
ping ping Devices supported This command is supported in Connect Family products only and not in Digi Cellular Family products or ConnectPort Display. Purpose Tests whether a host or other device is active and reachable. To interrupt the “ping” command, use Ctrl-C. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions ping=execute” for a user to use this command.
provision provision Devices supported This command is supported in Digi Cellular Family products that have a CDMA (Code-Division Multiple Access) module. Purpose Provisions the CDMA module in a Digi Cellular Family device. Provisioning establishes configuration settings in the CDMA module for use in a mobile network. Examples of CDMA-based mobile service providers include Sprint, Verizon, Alltel, and Midwest.
provision Important: Close PPP sessions before issuing provisioning commands The “provision” and “display provisioning” commands cannot be used while Point-to-Point Protocol (PPP) sessions are active. To close any existing PPP sessions: 1. Disable the PPP interface by entering a “set pppoutbound” command with these options: #> set pppoutbound port=interface port number state=disabled 2. Next, identify the ID of the connection, by issuing a “who” command. 3.
provision Use IOTA to provision the module provision type=iota spc=service programming code (MSL)(also known as master subsidy lock or MSL) mdn=mobile directory number min=mobile ID number Use OTASP to provision the module provision type=otasp otaspnumber=OTASP number - for example, *228 or *22899 Options SIP-only provisioning parameters type=siponly Specifies that the CDMA module is being provisioned using the SIPONLY method.
provision aaasstype={ascii|hex} default=ascii Specifies whether the AAA shared secret is specified in ASCII or hexadecimal form. This option affects how the shared-secret values are specified on the “aaass” option. ha=home address The home address for the CDMA module, specified as an IP address priha=primary host agent IP address The IP address of the primary host agent that provides mobile service for the CDMA module.
provision IOTA provisioning parameters type=iota Specifies that the CDMA module is being provisioned using the IOTA method. spc=service programming code (MSL) A six-digit number required to program CDMA module parameters. mdn=mobile directory number The phone number of the CDMA module. min=mobile ID number How the CDMA module is identified in the cellular network. Depending on the cellular provider, this number may be the same as the mobile directory number.
python python Devices supported This command is supported in Connectport X Family products only. Purpose Manually executes a Python program from the command line. The “python” command is similar to a command executed on a PC. However, other than a program name and arguments for the program, the command takes no arguments itself, and is currently unable to spawn an interactive session. Syntax python [(TFTP server ip):]filename [program args...
quit quit Devices supported This command is supported in all Digi Connect products. Purpose Use the quit command to log out of the device. Syntax quit Example #> quit See also "exit" on page 39. The “quit” and “exit” commands perform the same operation.
reconnect reconnect Devices supported This command is supported in all Digi Connect products. Purpose Reestablishes a previously established connection; that is, a connection opened by a “connect,” “rlogin,” or “telnet” command. The default operation of this command is to reconnect to the last active session. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions reconnect=execute” to use this command.
revert revert Devices supported This command is supported in all Digi Connect products. Purpose Sets a particular group of a devices’ settings to its default values. The “revert” command keywords are used one at a time to revert one group of settings. You cannot enter several keywords on a single command to revert multiple settings.
revert putty| python| rciserial| realport| rtstoggle| serial [port=range]| service| snmp| socket_tunnel| surelink| switches| system| tcpserial [port=range]| term [port=r a ng e]| udpserial [port=range]| user| video| vncclient| vpn {all|global|tunnel|phase1|phase2}| wireless] Options all Reverts all settings except these: • Network settings • Security settings (passwords and suppress login) • Host key settings. accesscontrol Reverts the access control settings configured by the “set accesscontrol” command.
revert command. ekahau Reverts the Ekahau client settings configured by the “set ekahau” command. See "set ekahau" on page 104. forwarding Reverts the port-forwarding settings configured by the “set forwarding” command. gpio Reverts the GPIO settings configured by the “set gpio” command. host Reverts the host name set by the “set host” command. ia Reverts the Industrial Automation (IA) settings configured by the “set ia” command. idle Reverts the settings configured by the “set idle” command.
revert pmodem [port=range] Reverts the modem emulation settings, configured by the “set pmodem” command. pppoutbound [port=range] Reverts the Point-to-Point Protocol (PPP) outbound connection settings, configured by the “set pppoutbound” command. profile [port=range] Reverts the profile settings configured by the “set profile” command. putty Reverts the terminal emulation settings configured by the “set putty” command. python Reverts the Python program settings configured by the "set_python" command.
revert command. udpserial [port=range] Reverts the UDP serial settings configured by the “set udpserial” command. user Reverts the user settings configured by the “set user” command. video Reverts the video settings configured by the “set video” command. vncclient [port=range] Reverts the settings configured by the “set vncclient” command. vpn {all|global|tunnel|phase1|phase2} Reverts the Virtual Private Network (VPN) settings configured by the “set vpn” command.
rlogin rlogin Devices supported This command is supported in Digi Connect Family and Digi Cellular Family products only. Not supported in ConnectPort Display. Purpose Performs a login to a remote system, also referred to as an rlogin. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions rlogin=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
send send Devices supported This command is supported in Digi Connect Family and Digi Cellular Family products only. Not supported in ConnectPort Display. Purpose Sends a Telnet control command, or special-character sequences, when connected using the Telnet client. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions telnet=execute” to display or set Telnet operating options.
set accesscontrol set accesscontrol Devices supported This command is supported in Digi Cellular Family products only. Purpose Used to specify information that limits network access to this device, or display current access-control settings. For the Digi Connect WAN, the access-control settings also limit routing of packets through the device.
set accesscontrol subnip[1-32]=ipaddress Used to specify up to 32 subnet IP addresses. Any IP address in these subnets will be allowed to access this device server. subnmask[1-32]=mask Used to specify a subnet mask associated with one of the 32 subnet IP addresses. Examples Set access control settings #> set accesscontrol enabled=on addrip1=143.191.1.228 Set access control for a specific subnet This command will allow any IP address in the 143.191.2.0 subnet (netmask 255.255.255.
set alarm set alarm Devices supported This command is supported in the following products: • Connect Family: Digi Connect EM, Digi Connect Wi-EM, Digi Connect ME, Digi Connect Wi-ME. Setting alarms in GPIO mode is not supported in the Digi Connect SP device. • All Digi Cellular Family products. Setting alarms in GPIO mode is not supported. • Not supported in ConnectPort Display. Purpose Configures device alarms and display current alarm settings.
set alarm Configure alarms based on GPIO pin states, where n is the GPO pin number set alarm range={1-32} mode=gpio [pins=list of pins|highpins=list_of highpins| lowpins=list of lowpins|pin{n}={high|low|ignore}| trigger_interval=seconds|reminder={on|off}| reminder_interval=seconds] Configure alarms based on data pattern matching set alarm mode=match match=string Configure alarms based on mobile signal strength (GSM) set alarm mode=rssi_gsm sig_strength_threshold=threshold time=time optimal_alarms_enabled=
set alarm Options General alarm options state= {on|off} Enables or disables all alarms. on Enables all alarms. off Disables all alarms. To avoid false errors, it is recommended that you configure alarms while alarms are disabled, and enable alarms after they are fully configured. The default is “off.” mailserverip=ipaddress Used to configure IP address of the mail server to which alarm-triggered emails are sent. from=string The text to be included in the “from” field of an alarm-triggered email.
set alarm Options for setting multiple alarms with the “range” option range= {1-32} Specifies the alarm or range of alarms for which alarm options are set. active={on|off} Enables or disables an alarm. on Enables an alarm. off Enables an alarm. The default is “off.” cc=string The text to be included in the “cc” field of an alarm triggered email.
set alarm ecio_1xrtt Alarms are triggered when the average Ec/Io 1xRTT signal strength on a CDMA device falls below a specified threshold for a specified amount of time. Optionally, a subsequent alarm is triggered when signal strength returns to the optimal state above the threshold. ecio_1xevdo Alarms are triggered when the average Ec/Io 1xEVDO signal strength on a CDMA device falls below a specified threshold for a specified amount of time.
set alarm type={email|snmptrap|all} Used to determine what kind of an alarm is sent: an e-mail alarm, an SNMP trap or both. For SNMP traps to be sent, the IP address of the system to which traps are sent must be configured, by issuing a “set snmp” command with the “trapdestip” option. See "set snmp" on page 198. email An email alarm is sent. snmptrap An SNMP trap is sent. If snmptrap is specified, the “subject” text is sent with the alarm. The MIBs for these traps are DIGI-SERIAL-ALARM-TRAPS.
set alarm reminder={on|off} The type of reminder sent. on An email or SNMP trap is sent periodically while the alarm-triggering event is active. The interval is based on the value of the “reminder_interval” option. off An email or SNMP trap is sent only when an alarm is triggered. reminder_interval=seconds The minimum reminder interval in seconds. Indicates how often an email or SNMP trap is sent when the “reminder” option is set to “on” and an alarm-triggering event is active.
set alarm mode=ecio_1xevdo Sets the alarm to 1xEV-DO Ec/Io signal-strength mode for a CDMA radio. signal_strength_threshold=threshold The threshold average signal strength., This is measured in dBm for rssi_gsm, rssi_1xrtt, and rssi_1xevdo (typically -120 dBm to -40 dBm) and dB for ecio_1xrtt and ecio_1xevdo (typically -24 dB to -2 dB). Note that “0 dB” reported by a “display mobile” command when there is no signal strength should properly be interpreted as the minimum value, which is -120 dBm or -24 dB.
set alarm Mobile temperature-based alarm options These options for setting alarms based on the radio’s reported temperature are supported in Digi Cellular Family products only. Note that temperaturebased options are not available with all radios. To determine if your radio supports these alarms, use the “display mobile” command. If the temperature is displayed, it can be monitored. mode=mobile_temp Sets the alarm to mobile temperature mode.
set alarm Examples Set a GPIO alarm and send an email message or SNMP trap This example shows how to set up a GPIO alarm to trigger when two GPIO pins go high, and sending an email message when they do. It also shows how to change from sending an email message when the alarm condition occurs to issuing an SNMP trap. Turn off alarms and set global email properties (this is done to avoid false error conditions triggering alarms): #> set alarm state=off mailserverip=10.0.0.1 from=myemail@digi.
set alarm Turn alarm #10 on. #> set alarm range=10 active=on mode=config_change Set all alarms to be sent to Connectware Manager, and turn on alarms: #> set alarm state=on cwm=on See also • • • • 80 "set gpio" on page 113. This command determines whether pins act as GPIO input, GPIO output, or standard serial. "set snmp" on page 198. "revert" on page 61 "show" on page 249.
set autoconnect set autoconnect Devices supported This command is supported in Digi Connect Family and Digi Cellular Family products only. Not supported in ConnectPort Display. Purpose Used to establish an automatic connection (autoconnection) between the serial port and a remote network destination, and to display current autoconnect settings.
set autoconnect Options port=range Used to specify the serial port. Optional on a single-port device. state={on|off} Enables or disables the autoconnect feature. on Enables the autoconnect feature. off Disables the autoconnect feature. The default is off. If you are using the serial port for another purpose, it is recommended this value be set to “off.” trigger={always|data|dcd|dsr|string} Indicates which events from the serial port will trigger a network connection to occur.
set autoconnect description=string A name for descriptive purposes only. ipaddress=ipaddress The IP address of the network destination to which a connection will be made. ipport=ipport The TCP port of the network destination to which a connection will be made. connect_on_string=string When the value of the “trigger” option is string, this option specifies the string that must be found in the serial data in order for a connection to occur.
set autoconnect Examples Set autoconnect on with trigger This example shows setting autoconnect to connect to the TCP port (2101) of the network IP destination when data arrives on the serial port. #> set autoconnect state=on trigger=data ipaddress=10.0.0.1 ipport=2101 Allow outgoing data that is either unacknowledged or less than maximum segment size #> set autoconnect port=1 nodelay=on See also 84 • • • • • "revert" on page 61. "set network" on page 149. "set serial" on page 189.
set bsc set bsc Devices supported This command supported in Digi Connect WAN Sync only. Purpose Configures the binary synchronous feature (also known as bisync or BSC) that provides bisync to IP protocol configuration. This feature allows you to attach a bisync terminal to the Digi device server’s serial port. The Digi device server emulates the host by polling the terminal. The bisync data is forwarded to the host over the TCP/IP network.
set bsc Syntax Enable/disable bisync communications and configure serial settings set bsc [state={disabled|enabled}] [serial_mode={bisync3270|bisync3275}] [baudrate={b a ud r a te )|external_clock}] Configure polling settings set bsc [code_set={ascii|ebcdic}] [text_conversion={on|off}] [polling_address=0x followed by 2 hex digits] [selection_address=0x followed by 2 hex digits] [device_id=0x followed by 2 hex digits] [poll_interval=m il l is ec o nd s ] [rx_timeout=m il l is e co nd s ] [tx_retries=0-255]
set bsc Options for polling settings code_set={ascii|ebcdic} Specifies whether the bisync terminal uses the ASCII or EBCDIC code set. This option determines the control characters used for serial communication and the format of text data if the “text_conversion” option is “on.” This option must match the setting used by the connected device. The default value is “ebcdic.
set bsc poll_interval=milliseconds Specifies the time interval between successive attempts to poll the bisync terminal. The default value is “1000,” or 1 second. rx_timeout=milliseconds Specifies the maximum time interval between sending data and receiving a response from the bisync terminal. If the expected response is not received within this interval, the data being sent is normally repeated to accommodate serial line transmission errors. The default value is “3000,” or 3 seconds.
set bsc power_on_message=(0x followed by up to 64 hex digits) The status message that is sent to the host the first time a connection is established after the Digi device server has been powered on or rebooted. no_response_message=(0x followed by up to 64 hex digits) The status message that is sent to the host when there has been no response from the bisync serial device. The message is sent after the receive has timed out for the number of retries specified on the “tx_retries” option.
set buffer set buffer Devices supported This command is supported in Digi Connect Family and Digi Cellular Family products only. Not supported in ConnectPort Display. Purpose Configures buffering settings on a port, or displays the port buffer configuration settings on all ports. The port buffering feature allows you to monitor incoming ASCII serial data in log form.
set buffer state The buffering state, which can be any of the following: on The data will be buffered. off The data will not be buffered and all data will be cleared from the buffer. pause The data will not be buffered, but data in the buffer will not be cleared. Examples Display port buffer configuration for all ports #> set buffer Configure buffers In this example, the set buffer command sets the buffer state for port 1 to on mode and the buffer size to 64 kilobytes.
set ddns set ddns Devices supported This command is supported in Digi Cellular Family products only. Purpose Configures a Dynamic DNS (DDNS) service. DDNS allows a user whose IP address is dynamically assigned to be located by a host or domain name. A DDNS service provider typically supports the registration of only public IP addresses. When using such a service provider, if your Digi Cellular Family device has a private IP address (such as 192.168.x.x or 10.x.x.
set ddns Set service settings for Dynamic DNS (service=dyndnsorg): set ddns [ddconntype={standardhttp|alternatehttp|securehttp}] [ddsystem={dyndns|statdns|custom}] [ddusername=user name] [ddpassword=password for DynDNS.org account] [ddhostname=full host name] [ddwildcard={off|on|nochg}] Display current DDNS settings set ddns Options Basic DDNS settings service={disabled|dyndnsorg} Specifies the DDNS service used for handling dynamic DNS updates, or disables use of the DDNS service.
set ddns DynDNS.com service settings These settings are specific to your account information with DynamuiDynDNS.org; please consult their website for more information on account terms and settings. ddconntype={standardhttp|alternatehttp|securehttp} The method to use to connect to the DynDNS.org server: standardhttp Connect to the Standard HTTP port (80). alternatehttp Connect to the Alternate HTTP port (8245). securehttp Connect to the Secure HTTPS port (443). ddsystem={dyndns|statdns|custom} The DynDNS.
set ddns nochg Specifies that there should be no change to service setting from the current selection for wildcards in the DDNS settings at the DynDNS.org Web site. Examples This example shows “set ddns” being used to display the current status of the Dynamic DNS service: #> set ddns DDNS Service Update Configuration : service : dyndnsorg ddconntype : securehttp ddsystem : statdns ddusername : "test" ddpassword : (Not shown for security reasons) ddhostname : "test-static.dnsalias.
set dhcpserver set dhcpserver Devices supported This command is supported in Digi Cellular Family products only. Purpose Configures the DHCP server settings for the Digi Connect product. A DHCP server allows other devices or hosts on the same local network as the Digi Connect product to be assigned dynamic IP addresses. This DHCP server supports a single subnetwork scope. The only DHCP server scope currently supported in Digi Connect firmware is for the “eth0” interface.
set dhcpserver Configure the DHCP server scope (“item=scope”) set dhcpserver item=scope [action={set|revert}] [enabled={on|off}] [startip=i p a dd r es s ] [endip=ip a d dr es s ] [leasetime={t im e |infinite}] (in seconds, 0=default (86400)} [offerdelay=0-5000] (time in milliseconds, default 500} [conflictdetect={on|off}] Configure the scope's address reservations (“item=reservation”) In this type of configuration, the DHCP server assigns a particular IP address to a Digi device, rather than a random add
set dhcpserver enabled={on|off} Enables the DHCP server feature on this Digi Connect product. Note that for the DHCP server to operate, the Digi Connect product must be configured to use a static IP address. startip=ip address The first IP address in the pool. endip=ip address The last address in the pool. The addresses in the range specified by “startip” and “endip” must be in the same subnet as the Digi Connect product.
set dhcpserver Options for configuring the scope's address reservations (“item=reservation”) item=reservation Specifies that the DHCP server configuration settings apply to the scope’s address reservations. You may use a reservation to create a permanent address lease assignment by the DHCP server. Reservations assure that a specified hardware device on the subnet can always use the same IP address. Address lease reservations associate a specific IP address with a specific client’s Ethernet MAC address.
set dhcpserver Options for configuring the scope's address exclusions (“item=exclusion”) item=exclusion Specifies that the DHCP server configuration settings apply to the scope’s address exclusions. An exclusion range is a limited sequence of IP addresses within a scope, excluded from DHCP service offerings. Exclusion ranges assure that any addresses in these ranges are not offered by the server to DHCP clients on the network.
set dhcpserver Examples Configure the IP address range for the DHCP server scope and enable it set dhcpserver item=scope action=set enabled=on startip=10.30.1.150 endip=10.30.1.199 Since the “leasetime” and “offerdelay” options are not specified, the default values for them are used, unless they were previously changed to another value by use of a “set dhcpserver item=scope” command (or using the web UI).
set dhcpserver Display current DHCP Server settings #> set dhcpserver DHCP Server Settings: server enabled : on scope name : eth0 starting ip address : 10.30.1.190 ending ip address : 10.30.1.198 lease time : 3600 (seconds) offer delay : 500 (milliseconds) addr conflict detect : off Reservation Settings: idx enabled ip address client id lease time --- ------- --------------- ----------------- ---------- 1 on 10.30.1.135 00:40:9D:24:73:F8 3600 2 on 10.30.1.
set dhcpserver See also • • • • "dhcpserver" on page 23. "revert" on page 61. "show" on page 249. In the Web user interface, the online help for Network Settings. “Configuring DHCP Sever Settings” provides more information on DHCP terminology and managing DHCP server operation.
set ekahau set ekahau Devices supported This command is supported in Digi Connect Wi-SP, Digi Connect Wi-ME, and Digi Connect Wi-EM only. Purpose Configures Ekahau Client™ device-location software in a Digi Connect wireless device. The Ekahau Client feature provides integrated support for Ekahau's Wi-Fi device-location solution on the Digi Connect Wi-ME, Digi Connect Wi-EM, and Digi Connect Wi-SP products.
set ekahau Options state={on|off} Enables or disables the Ekahau Client feature. The “id,” “name,” and “server” values must be set before you can set “state” to “on.” id=device id A numeric identifier for the Digi Connect device, used internally by the Ekahau Positioning Engine for device tracking over time. This identifier should be unique for each Digi device being located on the network. It must be configured before the device will allow the “state” option to be set to “on.
set ekahau Examples Set identifiers #> set ekahau id=1 server=myepe.domain.com name=”Tracked Device 1" Enable Ekahau Client #> set ekahau state=on See also 106 • • • "revert" on page 61. "show" on page 249. For additional information, including free evaluation licenses for the Ekahau Positioning Engine and Ekahau Site Survey software products, see the Ekahau Web site at www.ekahau.com.
set ethernet set ethernet Devices supported This command is supported in the following products: • Connect Family: Digi Connect SP, Digi Connect EM, Connect ME. • Digi Cellular Family: All Connect WAN products, but not ConnectPort WAN VPN. • ConnectPort Display. Purpose Configures, adjusts, and displays Ethernet communications options.
set ethernet speed Configures the Ethernet speed the Digi device will use on the Ethernet network. Specify an appropriate setting for your Ethernet network, which can be one of the following: 10 The device operates at 10 megabits per second (Mbps) only. 100 The device operates at 100 Mbps only. auto The device senses the Ethernet speed of the network and adjusts automatically. The default is “auto.
set forwarding set forwarding Devices supported This command is supported in Digi Cellular Family products only. Purpose Configures IP routing, or forwarding of IP datagrams, between network interfaces. IP routing must be enabled to allow the Network Address Table (NAT) and port forwarding features to work properly. The “set forwarding” command enables addition of static route entries to the IP routing table.
set forwarding Change an existing static route table entry To change an existing static route table entry, these options are required: staticrouteindex={1-8} action=change [one or more additional options] Delete a static route table entry To delete a static route entry, these options are required: staticrouteindex={1-8} action=delete Enable a static route table entry To enable a static route entry, all of its options must be specified (on this or a previous command) and valid.
set forwarding enabled={on|off} Enables or disables a static route table entry. on Enables an entry. All its options must be specified and valid to enable an entry. The enabled entry is immediately added to the device's IP routing table. off Disables an entry. If the entry was previously enabled and added to the device's IP routing table, that entry is immediately removed from the IP routing table.
set forwarding See also • • • • • 112 "display" on page 27. The “display route” command displays current routing information. "set nat" on page 146. "revert" on page 61 "show" on page 249. In the online help for the Web user interface, the topic “IP Forwarding Settings” under Network Configuration.
set gpio set gpio Devices supported This command is supported in the following products: • Connect Family: Digi Connect EM, Digi Connect Wi-EM, Digi Connect ME, Digi Connect Wi-ME. • Digi Cellular Family: Digi Connect WAN, and Digi Connect RG devices. Not supported in ConnectPort Display. Purpose Used to: • Configure General Purpose I/O (GPIO) pins. In normal operation, the GPIO pins are used for the serial CTS, DCD, DSR, DTR, and RTS pins.
set gpio Default serial signal settings for GPIO pins The default serial signal settings for the GPIO pins on a Digi Connect device are as follows. Depending on the device, there are five or nine GPIO pins.
set group set group Devices supported This command is supported in Digi Cellular Family products Digi Connect WAN and Digi Connect RG only. Purpose Used to create and manage user groups. You can use “set group” to do the following: • Add a group. A maximum of 32 groups can be defined. • Remove groups. • Change group configuration attributes. • Display group configuration attributes.
set group name= string Specifies the name of the group to be acted on. newname=string Specifies a new group name. commandline={on|off} Specifies whether the users in the group are allowed to access the command line of the device. on Users can access the command line interface. off Users can not access the command line interface. The default is “on.
set group Default permissions When a new group is created, it has no permissions.
set host set host Device support This command is supported in all products. Purpose Configures a name for the device, also known as a host name, or displays the current host name for the device. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions s-host=read” to display the current host name, and “set permissions s-host=rw” to display and set the host name.
set ia set ia Device support This command is supported in Digi Connect WAN IA, Digi Connect SP, Digi Connect Wi-SP, Digi Connect ME4, Digi Connect Wi-ME, Digi Connect EM, Digi Connect Wi-EM. Purpose Configures selected Digi devices to support special parsing and bridging of Industrial Automation (IA) protocols. For example, it enables the Digi device to function as a Modbus/TCP to serial Modbus Bridge.
set ia • • • implied network master encapsulated on TCP and UDP port 2101. So by default, incoming Modbus/RTU in TCP or UDP port 2101 is enabled. “set ia master=1” enables incoming Modbus/TCP masters. “set ia master=2” enables incoming Modbus/UDP masters (this is Modbus/TCP format by UDP port 502). “set ia table” assumes slaves 1 to 32 are on the serial port. Slave address (or Unit ID or Bridge Index) zero will be treated as 1.
set ia Configure destination tables and route entries (set ia table) set ia table=r an g e [t ab l e op t io n s] [route=ra ng e [r o ut e o pt i on s]] [ta b le o p ti o ns ]: state={on|off} name=st ri n g addroute=r o ut e i nd e x removeroute=r ou t e i nd ex moveroute=f r om _r o ut e _i nd e x,t o_ r ou te _ in d ex [ro u te o p ti o ns ]: active={on|off} connect={active|passive} protaddr=p r ot oc o l a dd re s s ra n ge type={discard|ip|mapto|nopath|serial} protocol={modbusrtu|modbusascii|modbustcp}
set ia table=1..8 (applies to master only) Defines which table is used to route messages to their destination. This option applies only to master-attached devices. protocol={modbusrtu|modbusascii} The protocol being used by the serial device. The serial protocol also affects the implied incoming network master on TCP and UDP ports 2101. modbusrtu Modbus/RTU – 8-bit binary per www.modbus-ida.org specification. modbusasscii Modbus/ASCII – 7-bit ASCII per www.modbus-ida.org specification.
set ia priority={high|medium|low} Normally messages are processed in a fair round-robin scheme. This becomes unfair when one master acts as many – for example opening 16 TCP sockets to talk to 16 slaves contrasted to a second master using a single TCP socket to talk to 16 slaves. In this situation, the device assumes it has 17 masters and in effect the first master will have 16 requests answered for every one the second master succeeds in getting answered.
set ia [modbus options] The configuration options specific to the Modbus protocol, which include: errorresponse={on|off} Controls behavior for common run-time errors such as no response from the slave device. By default, “errorresponse=off” for serial Modbus protocols, since most masters assume no response when errors occur. Having this option off also actively filters out returning Modbus exception codes 0x0A and 0x0B from remote Modbus/TCP slaves.
set ia Options for configuring network-based masters (set ia master) master=range Specifies the index of the network master to which the master options apply. state={on|off} Enables the IA network master settings. active={on|off} Enables or disables the network listener that accepts network connections. type={tcp|udp} Defines whether the incoming connection is TCP (connected) or UDP (unconnected). The default is “tcp.” For cellular connections, using UDP/IP can cut 40% to 60% from your monthly bill.
set ia idletimeout={0=disabled|1-99000 seconds} The device aborts a connection after the remote client has been idle for this time. The time is saved in seconds, and the best use for this timeout is to speed up fault recovery. For example, many wide-area networks can suffer shutdowns without the Digi device detecting it. Using the idle timeout will speed up detection of lost TCP connections. The range is 1 to 99999 seconds. The default is 5 minutes.
set ia Options for configuring destination tables and route entries (set ia table) The destination table and routes are used by the incoming master connections to select which one of many potential slaves a request is to be answered by. table=range Selects one of eight possible tables in which to look up forwarding information. [table options] The configuration options specific to the destination table, which include: state={on|off} Enables the IA destination table settings.
set ia type={discard|ip|mapto|nopath|serial} Defines the type of destination for this route. discard Messages destined for this route entry are discarded without error. ip Messages destined for this route entry are forwarded to the entered IP address. If you enter the IP address as 0.0.0.0, the Digi device’s IP address is used to fill in the IP address, and the “replaceip” function is applied. For example, if the IP is 0.0.0.0, the Digi device’s IP address is 143.191.23.
set ia ipport=ip port The UDP or TCP port on which to listen for protocol messages. Modbus/ TCP defaults to TCP port 502. This option applies only if the route “type=ip.” replaceip={on|add|sub|off} Specifies whether and how the last octet of the IP address is replaced. This option applies only if the route “type=ip.” on The protocol address is used to replace the last octet of the IP address. For example, if the table IP is 192.168.1.
set ia Examples Serial port configuration settings The following “set ia” commands show the default serial-port configuration settings for the Digi Connect WAN IA: set ia serial=1 active=on type=slave protocol=modbusrtu table=1 set ia serial=1 messagetimeout=2500 slavetimeout=1000 chartimeout=20 set ia serial=1 priority=medium idletimeout=0 set ia serial=1 errorresponse=off broadcast=replace fixedaddress=0 set ia table=1 route=1 active=on type=serial protaddr=0-32 port=1 Note that future Digi Connect WAN
set login set login Device support This command is currently supported in all Digi Connect Family devices except Digi Connect ES, Cellular Family products, and ConnectPort Display. Purpose Suppresses the user login for a Digi Connect device.
set menu set menu Devices supported This command is currently not supported in any Digi Connect Family devices. Purpose The “set menu” command is used to create and modify custom menus. For example, you can use custom menus to present a set of actions to users, or display a limited set of commands to users for security purposes. There are several modes of using the “set menu” command: • To update global settings for custom menus. • To add or update custom menus.
set menu quit_label=string The text displayed on the custom menu next to the “quit_key” that allows a user to quit and close the custom menu. The string is a short description. If the string contains spaces, enclose it in double quotes. The default is “Quit.” previous_key=key The key and text displayed on the custom menu next to the “previous_label” that allows a user to return to the previous menu when they have previously selected a submenu.
set menu newname=string A short descriptive string used to identify a menu. This option is used to create a new menu or to change the name of an existing menu. When a new menu is being created, this option must be specified along with the “range” option. When an existing menu name is being changed, this option must be specified along with either “range” or “name,” where “name” is the current name of the menu. If the string contains spaces, enclose it in double quotes.
set menu direction={horizontal|vertical} The direction in which to display and arrange menu items. This option only applies when the value of the “columns” option is more than 1 since a single column has no sense of direction other than vertical. horizontal The items will be displayed in order left-to-right first, then vertical. vertical The items will be displayed top-to-bottom first, then left-to-right.
set menu command=string The command that is executed when this menu item is selected. This may be any valid command on the CLI (command line interface). The user accessing the custom menu must have the necessary permissions for the supplied command in order to properly execute the command. Note that this option may not be combined with the “submenu” option. If the string contains spaces, enclose it in double quotes. submenu=string The menu displayed to the user upon selecting the menu item.
set mgmtconnection set mgmtconnection Devices supported This command is supported in all products except Digi Connect ES and ConnectPort Display. Purpose Configures or displays Connectware Manager server connection settings. The Connectware Manager server allows devices to be configured and managed from remote locations. These connection settings set up the connection to the Connectware Manager server so the Digi device knows how to connect to the server.
set mgmtconnection on Enables this instance for use. off Disables this instance for use. timedperiod=period For a timed connection, this option is used to specify the time interval in minutes between the device server's attempts to connect to the Connectware Manager server. If a device server is already in a connection to a Connectware Manager when the time interval expires, it will not start a new connection at that time.
set mgmtconnection clntreconntimeout={none|timeout} Specifies the retry timeout interval, in seconds, for a last-known-address (LKA) update, if the LKA update fails.If and 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 clientinitiated and server-initiated connections. The keyword “none” turns off the retry timeout interval feature.
set mgmtglobal set mgmtglobal Devices supported This command is supported in all products except Digi Connect ES and ConnectPort Display. Purpose The Connectware Manager server allows devices to be configured and managed from remote locations. This command is used to set or display the Connectware Manager global settings, or revert the device ID to factory settings.
set mgmtglobal rcicompressionenabled={on|off} Configures whether RCI command and response text is compressed, when both are passed between the Digi device and the Connectware 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.
set mgmtglobal connidletimeout={none|timeout value} Enables or disables the idle timeout for the Connectware 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.
set mgmtnetwork set mgmtnetwork Devices supported This command is supported in all products except Digi Connect ES and ConnectPort Display. Purpose The Connectware Manager server allows devices to be configured and managed from remote locations. The “set mgmtnetwork” command configures the network settings for the Digi device’s connection to the Connectware Manager server so the device knows how to connect to the server.
set mgmtnetwork connectionmethod={auto|none|mt|mdh|proxy} The Connectware Device Protocol firewall traversal method. auto Automatically detect the connection method. none No firewall; connect using TCP. mt Connect using TCP. mdh Connect using HTTP. proxy Connect using HTTP over proxy. proxyaddress=string The proxy host address when the connection method is “proxy.” proxyport=port The proxy host port when the connection method is “proxy.
set mgmtnetwork mtwaitcount=count Used to specify the wait count when the connection method is “mt,” where count is how many timeouts occur before the Digi device assumes the connection to the Connectware Manager server is lost and drops the connection. mdhrxkeepalive=time Used to specify the transmit keep alive time when the connection method is “mdh,” where time is the number of seconds to wait between sending keep-alive messages.
set nat set nat Devices supported This command is supported in Digi Cellular Family products only. Purpose Used to set or display Network Address Translation (NAT) and port/ protocol forwarding settings. Note that at this time, the only IP protocols for which protocol forwarding is supported are: • Generic Routing Encapsulation (GRE, IP protocol 47) • Encapsulating Security Payload (ESP, IP protocol 50, tunnel mode only). Port forwarding is supported for the TCP and UDP protocols.
set nat Options enabled={on|off} Enables or disables NAT. Note that IP forwarding must be enabled by the “set forwarding” command for NAT to work. on Enable NAT. off Disable NAT. maxentries=64-1024 The maximum number of concurrent NAT table entries that the device will support. This setting effectively limits the number of concurrent NAT rules and sessions that are permitted before disallowing them for resource constraint purposes. The maximum entries can range from 64 through 1024. The default is 256.
set nat poproto[1-64]={tcp|udp} The IP protocol associated with this port forwarding entry. tcp A TCP port is forwarded. udp A UDP port is forwarded. pocount=[1-64]=number of ports in range, minimum 1 The number of consecutive ports in a port-forwarding range. This option allows you to forward more than one port in a single port-forwarding entry. When a range is configured, the first port in the range is specified, and the full range is indicated in the displayed entry information. The default is 1.
set network set network Devices supported This command is supported in all Digi Connect products. Purpose Used to set general network configuration options and display current network configuration options, including options for IP address settings, TCP keep-alives, retransmissions of TCP packets, and ARP settings. The “garp” and “rto_min.” options can be used for optimizing for latency at the network level.
set network Options [ip address options] Set IP address-related options for the Digi device, including: ip=device ip address Sets the device IP address when DHCP is off. This option is only applicable if the “static” option is set to “on.” gateway=gateway ip Sets the network gateway IP address. submask=device submask Sets the device submask address when DHCP is off. This option is only applicable if the “static” option is set to “on.” The following three IP address options have a precedence.
set network [TCP keepalive options] Are options that configure how TCP keep-alive probes are sent. The keep-alive options (“idle,” “probe_count,” “probe_interval”) should be configured for various services that are configured by “set service keepalive={on|off},” or clients such as autoconnect (“set autoconnect keepalive={on|off}”). idle=10-86400 The amount of time, in seconds, to wait while not receiving TCP packets before sending out a keep-alive probe.
set network [ARP options] Are options that control Address Resolution Protocol (ARP) requests. arp_ttl=1-20 (minutes) The initial value of the ARP time-to-live variable, which is the amount of time that an ARP entry remains in the network ARP cache. When an ARP cache entry first populated, the ARP time-to-live variable is set to this value.
set passthrough set passthrough Devices supported This command is supported in Digi Cellular Family products only. Purpose Configures the IP pass-through feature. IP pass-through allows a Digi Cellular Family device to provide bridging functionality similar to a cable or DSL modem, where the Digi Cellular Family device becomes “transparent” to the router or connected device.
set passthrough Using Pinholes to Manage the Digi Cellular Family Device IP pass-through uses a concept called pinholes. You can configure the Digi Cellular Family device to listen on specific TCP ports, and terminate those connections at the Digi Cellular Family device for purposes of managing it. Those ports are called pinholes, and they are not passed on to the device connected to the Ethernet port of the Digi Cellular Family device.
set passthrough Using the “set service” command with IP Pass-through You can use the “set service” command to have a network service terminate both at a port on the Digi Cellular Family device and a different port on the connected device. For example, you could have the Digi Cellular Family device terminate the SSH service on port 2222, and the connected device terminate SSH at port 22.
set passthrough connectware={pass|terminate} Specifies whether the Connectware Manager application is configured to pass to the connected device (“pass”) or terminate at the Digi Cellular Family device for purposes of managing it, known as a pinhole (“terminate”). The default is "terminate.
set permissions set permissions Devices supported This command is supported in all Digi Connect Family devices. However, the extent of its use varies according to the user model implemented in the Digi Connect product. For Digi Connect products with one or two users, this command does not apply. It does apply to Digi products with two or more users. See "User Models and User Permissions in Digi Connect Products" on page 14 for more information.
set permissions Syntax Set permissions set permissions [type={user|group}] {id=range|name=string} [backup={none|execute}] [boot={none|execute}] [connect={none|execute}] [display={none|execute}] [dhcpserver={none|execute}] [buffers={none|r-self|read|rw-self|w-self-r|rw}] [filesys={none|read|rw}] [kill={none|execute}] [newpass={none|rw-self|rw}] [ping={none|execute}] [provision={none|execute}] [reconnect={none|execute}] [revert-all={none|execute}] [rlogin={none|execute}] [s-accesscontrol={none|read|rw}] [s-a
set permissions [who={none|execute}] [webui={none|execute} Display current permission settings set permissions Options Permission descriptions Here are the user permissions and their effects on commands. none The command cannot be executed. execute The command can be executed. r-self The user can execute the "display" portions for both commands if the user is logged in on the specified line. read The user can execute the "display" portions for both commands for any line.
set permissions connect={none|execute} Permissions for the “connect” command. (See "connect" on page 22.) dhcpserver={none|execute} Permissions for the "dhcpserver" command. (See "dhcpserver" on page 23.) display={none|execute} Permissions for the “display” command. (See "display" on page 27.) filesys={none|read|rw} Permissions for user access to the Digi Connect product’s file system. none The user cannot access the file system. read The user can read the file system.
set permissions s-alarm={none|read|rw} Permissions for the “set alarm” command. (See "set alarm" on page 70.) s-autoconnect={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “set autoconnect” command. (See "set autoconnect" on page 81.) s-bsc={none|read|rw} Permissions for the "set bsc" command. (See "set bsc" on page 85.) s-ddnsupdater={none|read|rw} Permissions for the "set ddns" command. (See "set ddns" on page 92.) s-dhcpserver={none|read|rw} Permissions for the "set dhcpserver" command.
set permissions s-permissions={none|read|rw} Permissions for the “set permissions” command itself. s-pmodem={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “set pmodem” command. (See "set pmodem" on page 164.) s-ppp={none|read|rw} Permissions for the “set pppoutbound” command. (See "set pppoutbound" on page 166.) s-profile={none|r-self|read|rw-self|w-self-r|rw} Permissions for the “set profile” command. (See "set profile" on page 172.
set permissions s-user={none|read|rw} Permissions for the “set user” command. (See "set user" on page 220.) s-vpn={none|read|rw} Permissions for the “set vpn” command. (See "set vpn" on page 228.) s-wlan={none|read|rw} Permissions for the “set wlan” command. (See "set wlan" on page 241.) status={none|read|rw} Permissions for the “status” command. (See "status" on page 254.) telnet={none|execute} Permissions for the “telnet,” “mode,” and “send” commands.
set pmodem set pmodem Devices supported This command is supported in the following products: • Connect Family: all products • Digi Cellular Family: All products except Digi Connect WAN. Not supported in ConnectPort Display. Purpose Used to configure various options for modem emulation over TCP/IP, and display current modem-emulation settings.
set pmodem telnet Enables or disables Telnet processing on incoming and outgoing modem-emulation connections. on Enables Telnet processing. off Disables Telnet processing. The default is “off.” Example #> set pmodem port=1 state=on See also • • • Chapter 2 Command Descriptions "revert" on page 61. "show" on page 249. Chapter 3, "Modem Emulation Commands" for descriptions of Digispecific commands for modem-emulation configurations.
set pppoutbound set pppoutbound Devices supported This command is supported in Digi Cellular Family products only. Purpose Configures Point-to-Point Protocol (PPP) outbound connections, or displays current PPP outbound settings.
set pppoutbound Options port=range The physical interface to which the PPP outbound configuration applies. Required. state={enabled|disabled} The state of the interface. The default is “disabled.” auth_method={none|PAP|CHAP|both} Determines whether authentication is required for outbound PPP connections and, if so, what kind. none The remote user does not require PPP authentication. pap Password Authentication Protocol (PAP) authentication is required.
set pppoutbound address_mask=ip address mask The IP mask to apply to the address specified on the “remote address” and “local address” options. When you specify a specific IP address on the “remote address” and “local address” options, this option modifies the meaning of the IP address for routing purposes. The default is 255.255.255.255. default_gateway={yes|no} Selects whether to use the PPP interface as the default route. The default is “no.
set pppoutbound lcp_keepalive={on|off} Specifies whether the device server sends Link Control Protocol (LCP) echo requests after a “quiet” interval, in order to test the PPP link and/or keep it alive. “Quiet” means not having received any bytes over the PPP link for a specified time interval, which is set by the “lcp_ka_quiet_time” option. In PPP networks that support LCP echoes, an LCP echo reply is returned by the remote end of the PPP connection.
set pppoutbound chap_id=chap id A character string that identifies the outbound PPP user using CHAP authentication. This is equivalent to a user or login name. The string must be 32 or fewer characters and must be recognized by the peer. chap_key=chap key A character string that authenticates the outbound PPP user using CHAP authentication. This is equivalent to a password. The string must be 16 or fewer characters and must be recognized by the peer.
set pppoutbound dial_script=chat script A dialing script, used any time a number is dialed for the interface. For example: dial_script="'' ATDT\T CONNECT \c" login_script=chat script A login script, used to log in to the remote system on the other end of the outbound PPP connection. For example: login_script=”ogin: assword: ” ipcp_dns_enabled={on|off} Enables or disables the IPCP (PPP Internet Protocol Control Protocol) acquisition of DNS IP addresses.
set profile set profile Devices supported This command is supported in all Digi Connect products. However, some port profiles are not supported in particular devices, as noted in the “profile” option’s description. Purpose Associates a particular port with one of several port configuration profiles, or displays the current port-profile settings. Port profiles are a defined set of port configuration settings for a particular use.
set profile Required permissions For Digi Connect products with two or more users, to use this command, permissions must be set to one of the following: • For a user to display the profile settings for the line on which they are logged in: “set permissions s-profile=r-self” • For a user to display the profile settings for any line: “set permissions sprofile=read” • For a user to display and set the profile settings for the line on which they are logged in: “set permissions s-profile=rw-self” • For a user t
set profile tcp_sockets Associates the TCP Sockets port profile with the port. tunneling Associates the Serial Bridge port profile with the port. udp_sockets Associates the UDP Sockets port profile with the port. Not supported in Digi Connect WAN. custom Associates the Custom port profile with the port. ia Associates the ia (Industrial Automation) port profile with the port. The default configuration settings assume Modbus/RTU slaves with addresses 1 to 32 are attached to the serial port.
set putty set putty Devices supported This command is supported in ConnectPort Display devices only. Purpose Configures terminal-emulation settings for ConnectPort Display, and displays current terminal-emulation settings. ConnectPort Display can emulate a terminal connected to a host/server over a serial line or the network. When connected over the network RealPort must be installed on the server.
set putty Options General terminal emulation options state={on|off} Enables or disables the terminal emulator. width={80|132} The default width of the terminal, specified as the number of columns of text to display on the terminal emulator. The default width is 80. height=10-60 The default height of the terminal, specified as the number of rows of text to display on the terminal emulator. The default height is 24.
set putty cursortype={none|block|underline|vertical} Specifies how the cursor appears on the terminal emulator display: as a block, an underline, a vertical line, or no cursor. none The cursor has no visible display characteristics. block The cursor is displayed as a block. underline The cursor is displayed as an underline (underscore) character. vertical The cursor is displayed as a vertical bar. The default is “underline.” blinkcursor={on|off} Enables or disables blinking of the cursor.
set putty characterset=host charset The character set for data received from the host. During a session, the terminal emulator receives a stream of 8-bit bytes from the server, and in order to display them on the screen it needs to know the character set in which to interpret these streams of bytes. There are several character sets from which to choose.
set putty The complete list of allowed character sets is: Character Set name Description ISO-8859-1 ISO-8859-1:1998 (Latin-1, West Europe) ISO-8859-2 ISO-8859-2:1999 (Latin-2, East Europe) ISO-8859-3 ISO-8859-3:1999 (Latin-3, South Europe) ISO-8859-4 ISO-8859-4:1998 (Latin-4, North Europe) ISO-8859-5 ISO-8859-5:1999 (Latin/Cyrillic) ISO-8859-6 ISO-8859-6:1999 (Latin/Arabic) ISO-8859-7 ISO-8859-7:1987 (Latin/Greek) ISO-8859-8 ISO-8859-8:1999 (Latin/Hebrew) ISO-8859-9 ISO-8859-9:1999 (Latin
set putty Character Set name Description Mac Iceland Mac Romanian Mac Greek Mac Cyrillic Mac Thai Mac Centeuro Mac Symbol Mac Dingbats Mac Ukraine Mac VT100 VISCII HP ROMAN8 DEC MCS UTF-8 Key mapping terminal emulation options Character codes received from a keyboard can be converted to different character codes before being sent to the host. This conversion, known as key mapping, can be useful when you have different types of keyboards that need to be mapped to the same set of character codes.
set putty The keymap entries are held in a table, as are other device settings such as UDP, serial destinations, alarms, etc. When adding a new entry (an “inseq”/”outseq” pair), you specify at what index in the table to add it using “keymaprange.” To delete an entry (or range of multiple entries) you specify the index/range with “deletekeymaprange.” Note that the Terminal Emulation settings in the Web user interface manages the indexes for you.
set putty Configure general terminal emulation settings Given the above settings, to adjust the screen height and cursor type, you would enter: # set putty height=30 cursortype=vertical Add, replace, and delete entries in the key mapping table To add/replace the first 3 entries in the table you would use the following commands: #> set putty keymaprange=1 indeq=A1 outseq=F1 #> set putty keymaprange=2 indeq=A2 outseq=F2 #> set putty keymaprange=3 indeq=A3 outseq=F3 Now, to delete the first 2 entries: #> s
set python set python Devices supported This command is supported in ConnectPort X products only. Purpose Configures Python programs to execute when the Digi device boots. Syntax set python [range=1–4] state={on|off} command=filename Options range=1 – 4 The index or indices to view or modify with the command. state={on|off} When the state is set to on, the command specified will be run when the device boots.
set rciserial set rciserial Devices supported This command is supported in Connect Family and Digi Cellular Family products. Not supported in ConnectPort Display. Purpose Used to: • Turn on/off RCI serial mode on the first serial port. The RCI serial mode is a mode that allows a configuration file to be loaded over a serial port when the DSR input signal is high. • Display current RCI serial-mode settings.
set realport set realport Devices supported This command is supported in all Digi Connect products. Purpose Configures and displays RealPort-related settings. Required permissions For Digi Connect products with root and non-root (normal) users, the root user can configure RealPort settings. The normal user can display RealPort settings.
set realport See also 186 • • "set network" on page 149. The “set network” keepalive options (“idle,” “probe_count,” “probe_interval,” “garbage_byte,” and “override_dhcp”) should be configured for various services that are configured by “set service keepalive={on|off},” or clients such as autoconnect (“set autoconnect keepalive={on|off}”). "set service" on page 191. • "set autoconnect" on page 81.
set rtstoggle set rtstoggle Devices supported This command is supported in the following products: • Connect Family: All products. • Digi Cellular Family: All products except Digi Connect WAN. Not supported in ConnectPort Display. Purpose Used to: • Enable or disable RTS toggle on a given serial port. RTS toggle is used to raise RTS when sending data. • Display current RTS toggle settings.
set rtstoggle predelay=delay Specifies the time in milliseconds to wait after the RTS signal is turned on before sending data. The range is 0 to 5000 milliseconds. The default is 0. postdelay=delay Specifies the time in milliseconds to wait after sending data before turning off the RTS signal. The range is 0 to 5000 milliseconds. The default is 0. Examples #> set rtstoggle state=on predelay=10 See also • • 188 "revert" on page 61. "show" on page 249.
set serial set serial Devices supported This command is supported in all Digi Connect products. Purpose Sets and displays general serial configuration options, such as baud rate, character size, parity, stop bits, and flow control.
set serial baudrate=bps The baud rate in bits per second. The default is 9600. csize={5|6|7|8} The character size, which can be 5, 6, 7, or 8 bits. The default is 8. flowcontrol={hardware|software|none} Specifies which kind of flow control is used on the line. hardware Hardware flow control (RTS/CTS). software Software flow control (Xon/Xoff). none No flow control. The default is “software.” parity={none|even|odd|mark|space} The parity used for the line. none No parity. even Even parity. odd Odd parity.
set service set service Devices supported This command is supported in all Digi Connect products. Purpose Used to: • Enable and disable network services. • Change the network port on which a given service listens. • Display the entire service table, or an entry in the service table. Caution on enabling and disabling services Exercise caution in enabling and disabling network services, particularly disabling them. Changing certain settings can render your Digi Connect product inaccessible.
set service keepalive={on|off} Indicates whether or not TCP keepalives will be sent for specified range of network services. If set to on, keepalives will be sent, if it is off, keepalives will not be sent. Configurable TCP keepalive parameters, for example, how many keepalives to send and when to send them are configured globally via the “set network” command (see "set network" on page 149).
set service Supported network services and their default network port numbers The following table shows the network services controlled by the “set services” command, the services provided, and the default network port number for each service.
set service Service Services Provided Default Network Port Number Advanced Digi Discovery Protocol (ADDP), also known as Device Discovery Discovery of Digi Connect products on a network. 2362 Encrypted (Secure) RealPort Secure Ethernet connections between COM or TTY ports and device servers or terminal servers. 1027 Hypertext Transfer Protocol (HTTP), also known as Web Server Access to web pages for configuration that can be secured by requiring a user login.
set service Service Services Provided Default Network Port Number Telnet Passthrough Allows a Telnet connection directly to the serial port, often referred to as reverse Telnet. 2001 Transmission Control Protocol (TCP) Passthrough Allows a raw socket connection directly to the serial port, often referred to as reverse sockets. 2101 User Datagram Protocol (UDP) Passthrough Used for testing the ability to send and receive over a UDP connection, similar to a ping.
set service Index numbers and changing default port numbers An index number is assigned to each of these services. The index numbers assigned can vary over time. If you want to change the network port number for a service, enter a “set service” or “show service” command to display the current index number assigned to all services. Locate the service for which you want to change the network port number, and note the index number for the service.
set service Examples Disable service #> set service range=1 state=off Change the network port (ipport) of a service #> set service range=1 ipport=500 Displaying the service table In this example, the “set service” command displays the entire service table. #> set service Displaying an entry in the service table In this example, the “set service” command displays a range of entries in the service table.
set snmp set snmp Devices supported This command is supported in all Connect Family and Digi Cellular Family products. Not supported in ConnectPort Display. Purpose Configures the Simple Network Management Protocol (SNMP) agent, or displays current SNMP settings.
set snmp authfailtrap={on|off} Enables or disables the sending of authentication failure traps. on Enables the sending of authentication failure traps. off Disables the sending of authentication failure traps. The default is “off.” coldstarttrap={on|off} Enables or disables the sending of cold start traps. on Enables the sending of cold start traps. off Disables the sending of cold start traps. The default is “off.” linkuptrap={on|off} Enables or disables the sending of link up traps.
set socket_tunnel set socket_tunnel Devices supported This command is supported in all Digi Connect Family and Digi Cellular Family products. It is not supported in ConnectPort Display products. Purpose Configures a socket tunnel. A socket tunnel can be used to connect two network devices: one on the Digi device server's local network and the other on the remote network. This is especially useful for providing SSL data protection when the local devices do not support the SSL protocol.
set socket_tunnel Options state={disabled|enabled Enables or disables the configured socket tunnel. timeout={0|seconds}] {0 is no timeout} The timeout (specified in seconds) controls how long the tunnel will remain connected when there is no tunnel traffic. If the timeout value is zero, then no timeout is in effect and the socket tunnel will stay up until some other event causes it to close.
set surelink set surelink Devices supported This command is supported in Digi Cellular Family products only. Purpose Configures Digi SureLink™ settings for a Digi Cellular Family device. Digi SureLink™ provides an “always-on” mobile network connection to ensure that a Digi Cellular Family device is in a state where it can connect to the network. It does this through hardware reset thresholds and periodic tests of the connection.
set surelink Set TCP connection link test parameters: set surelink [ipaddr1={ipv4 address|fqdn}] [ipaddr2={ipv4 address|fqdn}] [ipport=1-65535] Display current SureLink settings set surelink Options Options for Hardware reset thresholds module_reset_connect_failures={1-255|0=off} The number of failed connection attempts that occur before the cellular modem module is reset. This value can be a number between 1 and 255, or 0, which turns off the cellular modem module-reset feature. The default is 3.
set surelink test={ping|tcp|dns} The Link Integrity Monitoring test to be run. Each test can be used to demonstrate that two-way communication is working over the mobile connection. This variety of tests is provided because different mobile networks or firewalls may allow or block Internet packets for various services. The appropriate test may be selected according to mobile network constraints and user preference. The link integrity tests are performed only while the mobile connection is established.
set surelink dns DNS Lookup Test. This test uses a Domain Name Server (DNS) lookup as a test to verify the integrity of the mobile connection. The test is successful if a valid reply is received from a DNS server. Typically, this means the hostname is successfully “resolved” to an IP address by a DNS server. But even a reply such as “not found” or “name does not exist” is acceptable as a successful test result, since that demonstrates successful two-way communication over the mobile connection.
set surelink max_consecutive_failures={1-255, 0=off} (probe failures before link reset)] The maximum number of consecutive Link Integrity Monitoring tests. After this number is reached, the mobile connection should be disconnected and reestablished. This value must be between 1 and 255. The default is 3. A value of 0 turns off this feature. When the mobile connection is reestablished, the “consecutive failures” counter is reset to zero.
set surelink See also • • • • Chapter 2 "revert" on page 61. "show" on page 249. The "display pppstats" command displays connection and activity information for PPP links, including SureLink statistics. See "SureLink Statistics" on page 35 for descriptions of these statistics. Digi SureLink™ “Always-On” Connection White Paper, available from the Documentation page for Digi Cellular Family products at digi.com.
set switches set switches Device support This command is supported in ConnectPort TS MEI products only. Purpose Configures Multiple Electrical Interface (MEI) settings on a per-port basis, and displays current MEI settings. MEI settings include the type of electrical interface (EIA-232 or EIA-485), the number of differential wires used for communication, and whether termination and biasing resistors are used.
set switches Options range=range The port or range of ports to which this command applies. mode={232|485} Selects the electrical interface of the serial port. The selected value determines whether the "wires" and "termination" options are meaningful. 232 The serial port uses electrical interface EIA-232. This interface uses independent wires to transmit and receive data, which allows data to be sent and received between devices simultaneously. 485 The serial port uses electrical interface EIA-485.
set switches Examples Configure standard EIA-232 communication #> set switches port=1 mode=232 Configure a half-duplex EIA-485 endpoint #> set switches port=1 mode=485 wires=two termination=on Configure a full-duplex 422 interior node #> set switches port=1 mode=485 wires=four termination=off See also • • 210 "display" on page 27. The “display switches” command displays the current switch settings. "revert" on page 61. The “revert switches” command reverts the “set switches” configuration.
set system set system Devices supported This command is supported in all Digi Connect products. Purpose Configures and displays system-identifying information, such as a description of the device, its location, and a contact person. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions s-service=read” to display network service settings, and “set permissions s-services=rw” to display and change network service settings.
set tcpserial set tcpserial Devices supported This command is supported in all Digi Connect products. Purpose Used to set behaviors of TCP serial connections, or display current TCP serial settings. This command affects the following TCP serial connections: • Connections made using the autoconnect feature.
set tcpserial Options port=range Used to specify the serial port. Optional on a single-port device. hangupdcd={on|off} Indicates whether an established network connection should be terminated when the serial port’s DCD signal drops. The default is “off.” hangupdsr={on|off|} Indicates whether an established network connection should be terminated when the serial port’s DSR signal drops. The default is “off.
set tcpserial sendtime={0|1-65535ms} Indicates that data from the serial port should be sent out to the network after the given amount of time has past where no new data has arrived from the serial port. This option only is valid when the “buffered” option is “on.” A value of 0 (zero) disables this option. The default is 0. endpattern=string Indicates that data from the serial port should be sent out to the network after the given endpattern string has been found in the data from the serial port.
set term set term Devices supported This command is supported in all Digi Connect products except ConnectPort Display. Purpose Allows for connecting a terminal to a device’s serial port and accessing the command line of the device. In the cases where the default access to the terminal and the command line is “on,” this command is important if users want to use the serial port for purposes other than having a command line.
set udpserial set udpserial Devices supported This command is supported in all Digi Connect products except Digi Connect WAN and ConnectPort Display. Purpose Use this command to set up the UDP serial feature, or display current UDP serial settings. The UDP serial feature allows data to be sent between the serial port and one or more remote network destinations using the UDP protocol.
set udpserial Options Options for setting general UDP serial forwarding characteristics port=range Used to specify the serial port. Optional on a single-port device. state={on|off} Used to enable or disable sending data from the serial port to remote network destinations. The default is “off.” sendcount=bytes The number of bytes received from the serial port that will cause the data to be sent on to the network destinations. This trigger cannot be disabled. The default is 1024 bytes.
set udpserial sid={on|off} Determines how the socket ID (SID) string in the “sidstring” option is handled; that is, whether the string specified by the “sidstring” option is sent at the beginning of each UDP packet. on The value of “sidstring” is sent at the beginning of each UDP packet. off The value of “sidstring” is not sent at the beginning of each UDP packet. The default is “off.” sidstring=string The string sent at the beginning of each UDP packet if the “sid” option is set to on.
set udpserial ipport=ip port The UDP port of the destination to which data is sent. Options for displaying current UDP serial settings port=range Used to specify the serial port. Optional on a single-port device. range=range Identifies the range of UDP destinations to be displayed. Examples Set general UDP serial forwarding based on bytes received In this example, the amount of bytes received from the serial port will cause the data to be sent on to the network destination.
set user set user Devices supported This command is supported in all Digi Connect products. Purpose Used to: • Add users for access to a Digi Connect device. The number of users that can be defined varies by Digi Connect device. To determine the number of users allowed for your Digi Connect device, enter “set user” or “show user”. • Associate a user with a group. A user can be associated with up to two groups. • Disassociate a user from a group. • Remove users. • Change user configuration attributes.
set user Syntax Add a user set user add id=number newname=string Remove a user set user remove {id=range|name=string} Associate a user with a group set user associate {id=number|name=string} {gid=number|gname=string} Disassociate a user from a group set user disassociate {id=number|name=string} {gid=number|gname=string} Change user configuration attributes set user [id=range|name=string] [newname=string] [commandline={on|off}] [groupaccess={on|off}] [menu={none|index|name}] [defaultaccess={none|command
set user name= string Specifies the name of the user to be acted on. newname=string Specifies a new user name. gid=number Specifies the identifier for the group being associated with a user. If omitted, the “gname” option must be specified. gname=string Specifies the name of the group being associated with a user. If omitted, the “gid” option must be specified. commandline={on|off} Specifies whether the user is allowed to access the command line of the device. on User can access the command line interface.
set user defaultaccess={none|commandline|menu|group} Specifies the default access method and interface that a user will be given upon logging into the device. Note that the specified interface must be enabled for the user and have a valid menu and/or group if specified. none The user has no default access to the device and must explicitly specify the access type.
set user public_key={tftphost:filename|clear} Loads or clears an SSH public key used for authentication of this user. The key must be an RSA public key, in either OpenSSH or the IETF draft format. tftphost:filename Loads an SSH2 public key for use with this user, where: tftphost The IP address or DNS name of a host from which the SSH public key will be downloaded to the Digi Connect device using TFTP. filename The name of a file on the host that contains the SSH public key.
set video set video Devices supported This command is supported in ConnectPort Display only. Purpose Configures or displays video settings for ConnectPort Display. Syntax Configure video settings set video mode={640x480@60-16|800x600@56-16|800x600@60-16| 1024x768@70-8} splash_time=0-30 seconds Display current video settings set video Options mode={640x480@60-16|800x600@56-16|800x600@60-16| 1024x768@70-8} The resolution, refresh rate, and color depth of the display screen.
set vncclient set vncclient Devices supported This command is supported in ConnectPort Display only. Purpose Configures or displays remote-access settings. Your ConnectPort Display can provide remote access to a computer on the network or Internet using the VNC (Virtual Network Computing) protocol. VNC server software must be installed on the remote computer. A VNC server is provided on your ConnectPort Display Software and Documentation CD.
set vncclient keepalive={on|off} Indicates whether or not TCP keep-alives will be sent while connected to the VNC server. Keep-alives help to detect when a connection has been lost. TCP keep-alive parameters (such as how often to send them) are configured globally. Example #> set vncclient state=on server=10.20.1.107 port=5900 password=dnf10 reconnect=10 shared=on localcursor=on See also • • • • • Chapter 2 "revert" on page 61. "set service" on page 191.
set vpn set vpn Devices supported This command is supported in Digi Cellular Family products only, except Digi Connect WAN. Purpose Configures Virtual Private Network (VPN) settings. Virtual Private Networks (VPN) are used to securely connect two private networks together so that devices may connect from one network to the other network using secure channels. VPN uses IP Security (IPSec) technology to protect the transferring of data over the Internet Protocol (IP).
set vpn • • Configure IKE/ISAKMP SA Phase 1 and Phase 2 options, which create an authenticated secure channel and specify how IKE negotiates security associations (SAs). Display current VPN settings.
set vpn [is a km p o pt i on s]: mode=isakmp [shared_key={a sc i i k ey |he x k ey }] To specify proposals: see syntax and options for “Set IKE/ISAKMP SA Phase 2 Options.
set vpn Options Global VPN options set vpn global Specifies that the “set vpn” command is for setting global VPN options. mode={main|aggressive} The method used to negotiate Internet Key Exchange (IKE) Phase One using Internet Security Association and Key Management Protocol (ISAKMP). Negotiations establish security settings and a secure channel for subsequent messages. For the negotiations to progress, both sides must be configured identically.
set vpn identity=ip-address Identity is specified as the Digi device’s IP address. Using this method, you can specify either of the following: The Network Address (IPv4): A standard IP address (version 4). that uses the standard IPv4 dotted format (four numeric values between 0 and 255 separated by periods). For example: 10.0.0.1 The Mobile IP address as the identity: This means that the IP address of your mobile network interface will automatically be used as the VPN identity.
set vpn antireplay={on|off} Specifies whether the antireplay feature is on or off. Antireplay allows the IPsec tunnel receiver to detect and reject packets that have been replayed. It does this by adding information to the packets exchanged between VPN endpoints, to ensure that a third party cannot replay the same information to one of the VPN endpoints at a later time to recreate the secure channel again. Important: If using manually-keyed tunnels, disable this option.
set vpn remote_vpn_endpoint=(fqdn|ip address} The IP address or hostname of the peer with which the VPN connection is established. remote_tunnel_addr=ip address remote_tunnel_mask=subnet mask remote_tunnel_range=ip address-ip address These options specify the routes required to access clients on the remote network. They also specify the remote peers that local clients are allowed to connect to. The remote network specifies the private network to which the remote VPN endpoint is connected.
set vpn inbound_authentication={none|md5|sha1} The optional authentication algorithm, used with the associated authentication key specified by the “inbound_auth_key” option, to authorize access on the VPN tunnel for inbound traffic. none No authentication algorithm is used. md5 MD5 authentication algorithm, which uses 128-bit keys. sha1 SHA1 authentication algorithm, which uses 160-bit keys.
set vpn inbound_enc_key={ascii key|hex key} The encryption key for inbound traffic, according to the authentication algorithm specified by the “inbound_encryption” option. The encryption key may be specified as an ASCII value using alphanumeric characters or may be specified as a hexadecimal value prefixed by “0x”. The following table lists the associated lengths of the encryption keys based on the encryption algorithm.
set vpn [isakmp options] To configure an ISAKMP tunnel, you must configure the settings to match those on the remote VPN server. mode=isakmp Indicates that the settings are for a VPN ISAKMP tunnel. ISAKMP tunnels specify a list of proposals, or security policies, in order to negotiate a set of security settings from the remote VPN endpoint. shared_key={ascii key|hex key} A key that secures the VPN tunnel.
set vpn IKE/ISAKMP SA Phase 1 options set vpn phase1 Specifies that the “set vpn” command is for configuring a VPN Phase 1 options. index=1-2 The index number for an existing VPN tunnel. state={enabled|disabled} Whether the VPN tunnel is enabled or disabled. You can use this option when creating several tunnels, where only one would be used initially. In that case, you would add a disabled tunnel for future use and enable it on a subsequent “set vpn” command.
set vpn sa_lifetime=10-2^32 Determines how long an Security Association (SA) policy is active, in seconds. After the IKE SA has been negotiated, the SA lifetime begins. Once the lifetime has completed, a new set of SA policies are negotiated using IKE phase 2 negotiation. sa_lifetime_data=0-2^32 The amount of data, in bytes or kilobytes, that is sent and received until the SA is renegotiated. This value is analogous to the SA lifetime. Also known as SA life size.
set vpn authentication={none|md5|sha1} The authentication algorithm used in authenticating clients. none No authentication. No authentication can be used to save time and CPU cycles. It is not as secure, but the peers were authenticated in phase 1. md5 MD5 authentication, which uses 128-bit keys. sha1 SHA1 authentication, which uses 160-bit keys. encryption={none|des|3des|aes} The encryption algorithm used for encrypting data. none No encryption is used.
set wlan set wlan Devices supported This command is supported in Digi Connect Wi-ME, Digi Connect Wi-EM, and Digi Connect Wi-SP devices. Purpose Configures wireless devices, or displays the status of wireless devices. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions s-wlan=read” to display wireless settings, and “set permissions s-wlan=rw” to display and change wireless settings.
set wlan Authentication methods and associated data fields The following table shows the authentication methods available for wireless devices, and the associated data fields, or command options, that apply to each method. All data fields with that have an X in a particular authentication method’s column are required, except for trusted certificates, which is optional. Data Fields: Authentication Method: Open WEP keys X If WEP encryption is selected.
set wlan Inner and outer protocols The following table shows relationships between outer protocols and inner protocols specified on the “set wlan” command. Outer protocols are the types of Extensible Authentication Protocols (EAP) that are allowed to establish the initial connection with an authentication server or access point. The outer protocols are specified by the “outer_eap” option. Inner protocols are the types of protocols that are allowed to authenticate the device.
set wlan Display wireless settings set wlan Or: show wlan Options Regarding command options “authentication encryption,” “outer_eap,” “inner_eap,” and “options:” These options have multiple values. More than one value may be specified for each option to indicate the set of allowed values. The actual value used will be determined by the capabilities of the wireless network. protmode={bss|ibss_create|ibss_join|any} Used to change the operation mode in which the device will work.
set wlan authentication= {[open],[sharekey],[wep_auth],[wpa_psk],[wpa_auth],[leap],[any]} The types of authentication that are allowed to establish a connection with the access point. open IEEE 802.11 open system authentication is used to establish a connection with the access point. sharedkey IEEE 802.11 shared key authentication is used to establish a connection with the access point. At least one WEP key must be specified to use shared key authentication. wep_auth IEEE 802.
set wlan encryption={[open],[wep],[tkip],[ccmp],[any]} The types of encryption that are allowed to encrypt data transferred over the wireless link. open No encryption is used over the wireless link. Can be used with open and sharedkey authentication. wep Wired Equivalent Privacy (WEP) encryption is used over the wireless link. Can be used with open, sharedkey, wep_auth, wpa_psk, wpa_auth, and leap authentication. tkip Temporal Key Integrity Protocol (TKIP) encryption is used over the wireless link.
set wlan inner_eap={[gtc],[md5],[mschapv2],[otp],[chap],[mschap], [ttls_mschapv2],[pap,[any]]} The types of protocols that are allowed to authenticate the device. These are used within the encrypted connection established by PEAP or TTLS. The following are Extensible Access Protocols (EAP) that can be used with PEAP or TTLS: gtc Generic token card. md5 Message Digest Algorithm (MD5). mschapv2 Microsoft Challenge response Protocol version 2. otp One Time Password.
set wlan psk=string Used when the “security” option is set to “wpa_psk.” This option specifies a string that is converted into a pre-shared key (PSK) that is used for encryption. wepmode={64bit|128bit} Specifies the key size used when WEP encryption is enabled. The default is 64bit. wepindex=1-4 Specifies which of the 4 possible keys will be used. The default is 1. wepkeyN=hex string A hexadecimal string that serves as the key if WEP encryption is enabled.
show show Devices supported This command is supported in all Digi Connect products. Purpose Displays the current settings in a device, including current configuration settings, boot code loaded in the device, and the effects of commands issued to the device.
show 250 Works w/ range option Displays settings configured by Works w/ port option group set group No No host set host No No ia master set ia command: settings for an IA master; see "Configure network-based masters (set ia master)" on page 120. No ia serial set ia command: settings for IA serial; see "Configure serialport connected devices (set ia serial)" on page 120.
show Chapter 2 Works w/ range option Displays settings configured by Works w/ port option route The IP routing table. This command is not associated with a “set” command.
show port=range Identifies a particular serial port. Optional on a single-port device. range=range A configuration table entry or range of entries. Examples Display network configuration settings #> show network Network configuration: MAC Address : 00:40:9D:24:8B:B3 Currently in use by the network stack Stored configuration -------------------- ------------------- ipaddress : 10.8.16.8 192.168.4.25 submask : 255.255.0.0 255.255.0.0 gateway : 10.8.1.1 0.0.0.
show Display wireless settings In addition to showing the current wireless settings, "show wlan" displays evaluation notes and warning messages about the effect and interaction of wireless settings. As the example shows, warning messages note encryption methods that have been defined but not used by any authentication methods, and notes identify whether configuration of certain features appears to be complete.
status status Devices supported This command is supported in all Digi Connect products. Purpose Displays the current list of sessions. The “status” command displays the status of outgoing connections (connections made by “connect,” “rlogin,” or “telnet” commands). In contrast, the “display” command displays real-time information about a device, while the “info” command displays statistical information about a device over time. Typically, the “status” command is used to determine which sessions to close.
telnet telnet Devices supported This command is supported in all Digi Connect Family devices. Purpose Used to make an outgoing Telnet connection, also known as a session. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions telnet=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
vpn vpn Devices supported This command is supported in Digi Cellular Family products only, except Digi Connect WAN. Purpose Manages and displays the status of a Virtual Private Network (VPN) tunnel. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions vpn=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands.
vpn Enable a VPN tunnel This command enables the tunnel at index 1 to be used. #> vpn connect index=1 See also • • • • • • Chapter 2 "display" on page 27. The “display sadb,” “display sp,” and “display vpn” commands display VPN-related connection and status information. "revert" on page 61. The “revert vpn” options revert groups of VPN settings, or all VPN settings. "set vpn" on page 228. The “set vpn” command configures VPN settings.
who who Devices supported This command is supported in all Digi Connect products. Purpose Displays active connections to and from the device. Required permissions For Digi Connect products with two or more users, permissions must be set to “set permissions who=execute” to use this command. See "set permissions" on page 157 for details on setting user permissions for commands. Syntax who Options None at this time.
What Is Modem Emulation? Modem Emulation Commands Chapter 3 This chapter describes the commands that can be issued when Digi Connect products are configured in modem emulation mode. What Is Modem Emulation? Modem emulation enables a system administrator to configure a networked Digi device to act as a modem. The Digi device emulates modem responses to a serial device and seamlessly sends and receives data over an Ethernet network instead of a PSTN (Public Switched Telephone Network).
Common User Scenarios for Modem Emulation Common User Scenarios for Modem Emulation The Digi device in modem emulation mode allows for the easy replacement of modems in almost any environment where there is a LAN or WAN. User Scenario - Diagram A Workstation Serial cable DIG IO NE Digi device Ethernet Server 192.168.25.5 In Diagram A, the Digi Connect device replaces a modem connected to a workstation running an application.
Common User Scenarios for Modem Emulation User Scenario - Diagram B Workstation Serial cable DIG IO NE Ethernet Workstation Digi device Serial cable DIG IO NE Digi device In Diagram B, two Digi devices will replace modems on both sides of the connection. The initiation of the connection occurs with either of the Digi devices. If both ends are Digi devices, the TCP listening port number is 50001 for port 1. An example of the connection command is ATDT 192.168.25.30:50001.
Connection Scenarios for Modem Emulation Connection Scenarios for Modem Emulation Modem emulation can involve the following types of connection scenarios: Outgoing Modem Emulation Connection In an outgoing modem emulation connection, a serial device sends an ATDx.x.x.x:y command, which triggers the Digi device to establish a connection to destination IP=x.x.x.x, port=y.
About the Commands in this Chapter About the Commands in this Chapter This chapter describes the Digi-specific modem emulation commands that have been implemented for Digi Connect devices. It is divided into several sections: • The AT command set. These are commands to perform actions in a modem-emulation connection. • Modem S-Register definitions. • A description of the result codes for the commands.
Modem Emulation AT Command Set Modem Emulation AT Command Set The following commands can be issued to perform actions in a modememulation configuration scenario. AT Command Result Code Function n+++n When in data mode, this command causes the modem to switch to command mode. The value of n corresponds to the required delay before and after the escape sequence is entered. The delay can be changed by modifying S-register 12. The escape character can be changed by modifying S-register 2.
Modem Emulation AT Command Set AT Command ATO ATQn Function Result Code Return to on-line data mode. If the modem is in the on-line command mode, the modem enters the on-line data mode. If the modem is in the off-line command mode (no connection), ERROR is reported. • O0, O1: If there is an active connection, switches the modem to data mode. OKn = 0 or 1 and a connection exists. ERROR Otherwise or if not connected. Quiet results codes control command.
Modem Emulation AT Command Set AT Command AT&V Displays current values and settings. • AT&V0- AT&V5: Displays S-Register/command values for the current and stored configuration. • AT&Wn 266 Result Code Function AT&V6: Displays current network settings. Store configuration. Stores the specified S-registers in flash memory.
S-Register Definitions S-Register Definitions Following is a description of the S-registers that can be set. Register Function Range Units Default S0 Rings to Auto-Answer. Sets the number of rings required before the Digi device automatically answers a call. Setting this register to Zero disables auto-answer mode. 0-255 Rings 0 S1 Ring Counter. Specifies the current number of rings. S1 is incremented each time the modem detects a ring signal on the telephone line.
S-Register Definitions Register Function Range Units Default General Options Status. Indicates the status of command options. • Default: 52 (34h) (00110100b) • Bits 0 - 2: Ignored. • Bits 3-4: DTE’s DTR behavior (&Dn): 0 = DTR drop is ignored (&D0). 1 = DTR drop causes a transition from data to command mode without hanging up an existing connection (&D1). S21 2 = DTR drop hangs up the existing connection (&D2) (Default.) • - - 52 (34h) 0-255 s or 0.
Result Codes Result Codes Following is a description of the return codes returned by modem emulation commands.
Result Codes 270 Chapter 3 Modem Emulation Commands
Index ? command 40 100% CPU utilization 28 232 electrical interface 209 2-wire mode 209 485 electrical interface 209 4-wire mode 209 A abbreviating commands 12 abort output signal 67 access control 68 newpass command 51 set user 220 status information 27 access permissions for commands 14 add line feed characters 50 Advanced Digi Discovery Protocol (ADDP changing password for 51 Advanced Digi Discovery Protocol (ADDP) caution on disabling 191 default port number 194 description 194 alarms 70 configuring 7
CPU utilization 28, 42 CTS GPIO pin for 113 hardware flow control 190 Custom port profile 172 D DCD altpin field (swapping DCD with DSR) 189 GPIO pin for 113 hangupdcd field 213 DDNS (Dynamic DNS) service 92 default configuration file names 18 default values filenames for device configurations 18 reverting to 61 device alarms 70 device configuration restoring from a TFTP server 18 restoring to factory defaults 19 saving 18 device description 211 device IP address 150 device name (set host command) 118 devi
status of signals 27 Generic Routing Encapsulation (GRE) protocol 146 go ahead signal 67 GPIO.
enabling and disabling 191 new-line character 13 newpass command description 51 enabling login prompt 14 setting permissions for 160 no option signal 67 none user permission 159 O octal bytes in strings 13 odd parity 190 online help 12, 40 operating system updates 19 OTP 243 overflow errors 45 overrun errors 45 P PAP 243 PAP authentication 167 parameter 28 parity 190 parity errors 45 password creating 51 for devices 51 passwords for Dynamic DNS (DDNS) service 92 PEAP 243 Perfect Forward Secrecy (PFS) 232
r-self user permission 159 RTS GPIO pin for 113 in hardware flow control (RTS/CTS) 190 RTS toggle 187 rw user permission 159 rw-self user permission 159 S Secure Shell (SSH) 194 Secure Socket Service 194 Secure Sockets Layer (SSL) 212 security changing user passwords 51 Connectware Device Protocol device security settings 96 password for ADDP 51 Security Association (SA) database 27, 29 security features authentication 220 newpass command 51 passwords 51 set user command 220 Security Policy Database (SPD)
set mgmtglobal command description 140 displaying current settings 140, 250 reverting settings 63 setting permissions for 161 set mgmtnetwork command description 143 displaying current settings 143, 250 reverting settings 63 setting permissions for 161 set nat command description 146 displaying current settings 146, 250 reverting settings 63 setting permissions for 162 set network command description 149 displaying current settings 149, 250 reverting settings 63 setting permissions for 161 set passthrough c
reverting settings 65 setting permissions for 163 show command description 249 displaying Industrial Automation settings 121 displaying number of users defined 14 sigchange 45 Simple Network Management Protocol (SNMP) "get" commands 198 "set" commands 198 configuring 198 enabling and disabling 191 enabling/disabling sending of traps 199 network service for 194 private community string 198 public community string 198 set snmp command 198 SNMP See Simple Network Management Protocol socket ID 213, 218 socket t
V vertical tab character 13 video settings 225 VNC (Virtual Network Computing) protocol set vncclient command 226 VNC client configuration 191 VNC Client Listen Daemon 195 VNC server configuration 191, 195 vpn command description 256 setting permissions for 163 W Web user interface access setting permissions for 163 who command description 258 relationship to kill command 49 setting permissions for 163 wired devices, configuring 96 wireless devices configuring 241 displaying current settings for 253 Ekahau
